Update README.md

Author: ClaudioPrimerano

database/README.md

@@ -10,13 +10,13 @@ You can enable or disable database versioning by setting the **VERSIONING** envi
 
 For more information about the database versioning, refer to the [Database Versioning Documentation](https://github.com/istSOS/istsos-miu/blob/traveltime/database/README_VERSIONING.md)
 
-### Database fake data
+### Database dummy data
 
-When you build the Docker image, the script will automatically clear the database and add static and dynamic values. 
+You can enable or disable the addition of dummy data by setting **DUMMY_DATA** environment variable in the `.env` file.
 
-To disable the addition of these data, set **dummy_data** to *False* in the `/dummy_data/config.yaml` file.
+You can enable or disable the cleaning by setting **CLEAR_DATA** environment variable in the `.env` file.
 
-To prevent clearing the database, set **clear_data** to *False* in the `/dummy_data/config.yaml` file.
+For more information about the database dummy data, refer to the [Database Dummy Data Documentation](https://github.com/istSOS/istsos-miu/blob/traveltime/dummy_data/README.md)
 
 ### Connect to database in DBeaver
 

dummy_data/README.md

@@ -1,21 +1,24 @@
 # Dummy data
 
-This container create a random dataset to mimik real case monitoring network. It allows to create a specified number of entities ("things") for each observed properties with observations over a defined time interval with a given frequency. Additionally, it includes information about locations, historical locations, features of interest, sensors, datastreams, and observations associated with the things.
+This container generates a random dataset to mimic a real-world monitoring network. It allows you to create a specified number of entities ("things") for each observed property, with observations over a defined time interval at a given frequency. Additionally, it includes information about locations, historical locations, features of interest, sensors, datastreams, and observations associated with the things.
 
 ## Input Parameters
 
-- `n_things` (int): Specifies the number of things being observed in the dataset.
-- `n_observed_properties` (int): Denotes the number of different properties or features being recorded for each item.
-- `interval` (str): Defines the time interval over which the data is generated. The format "P1Y" follows the ISO 8601 duration format, indicating a period of 1 year.
-- `frequency` (str): Sets the frequency at which data points are recorded. "PT30M" is in the ISO 8601 duration format, representing a period of 30 minutes.
+- `N_THINGS (int)`: Number of things being observed in the dataset.
+- `N_OBSERVED_PROPERTIES` (int): Number of different properties or features being recorded for each thing.
+- `INTERVAL` (str): Time interval over which the data is generated, following the ISO 8601 duration format (e.g., "P1Y" for a period of 1 year).
+- `FREQUENCY` (str): Frequency at which data points are recorded, using the ISO 8601 duration format (e.g., "PT30M" for a period of 30 minutes).
+- `START_DATETIME` (str): Specifies the start date for phenomenonTime
 
-## Other entities
+## Entities Counts
 
-- `Locations`, `HistoricalLocations`, and `FeaturesOfInterest`: The number of these entities is equal to the number of things.
-- `Sensors` and `Datastreams`: The number of these entities is equal to the number of things multiplied by the number of observed properties.
-- `Observations`: The number of observations for each datastream depends on the frequency and interval. For this specific case, there is one observation every 30 minutes for one year.
+- `Locations`, `HistoricalLocations`, and `FeaturesOfInterest`: One per thing.
+- `Sensors` and `Datastreams`: : One per thing per observed property.
+- `Observations`: Number of observations for each datastream depends on the frequency and interval (e.g., one observation every 30 minutes for one year).
 
-## Data Generation
+## Data Generation Options
 
-- `dummy data` (bool): Indicates whether the dataset should be populated with dummy data.
-- `clear data` (bool): Indicates whether the dataset should be cleared.
+- `DUMMY_DATA` (bool): Specifies whether the dataset should be populated with dummy data.
+- `CLEAR_DATA` (bool): Specifies whether the dataset should be cleared before generating new data.
+
+By adjusting these parameters, you can create a customized dataset that suits your needs for testing and development purposes.