ChaProEV 1.2.6__tar.gz → 1.2.7__tar.gz

{chaproev-1.2.6 → chaproev-1.2.7}/.gitignore

@@ -9,4 +9,6 @@ site/
 .venv/
 reference_run/
 reference_run_prev/
-reference_run_previous/
+reference_run_previous/
+non-road-output/
+

{chaproev-1.2.6/src/ChaProEV.egg-info → chaproev-1.2.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ChaProEV
-Version: 1.2.6
+Version: 1.2.7
 Summary: ChaProEV: Charging Profiles of Electric Vehicles
 Author-email: Omar Usmani <Omar.Usmani@TNO.nl>
 Project-URL: Homepage, https://github.com/TNO/ChaProEV
@@ -37,7 +37,8 @@ This repository contains the ChaProEV (Charging Profiles of Electric Vehicles)
 model.
 
 ## Status
-The ChaProEV model is under construction and not yet ready for use.
+The ChaProEV model is currently released and useable. This version
+has been used in projects and can be used in future projects.
 Please contact the authors below if you have questions or requests to get
 model runs at some point.
 
@@ -85,7 +86,18 @@ To run the model, you need to put a ChaProEV.toml configuration
 in the folder where you run your model. You also need to have at least one scenario in your scenario/case_name (e.g. scenario/Mopo) folder. A
 If you want to create varaints, then you need to add a case.toml (e.g. Mopo.toml) file in the variants folder and put a variant file in the variants/case (e.g. variants/Mopo) folder. 
 If you want to compute fleet-level values and/or do a car owndriveway/street charging split, you need to put some files in the input/case (e.g. input/Mopo) folder.
-You can use the examples provided in this repository.
+You can use the examples provided in this repository. You can also
+unzip [this file](https://github.com/TNO/ChaProEV/blob/main/ChaProEV_test_case_configuration_files.zip)
+into your working folder and use 'test_case'  as your case name:
+```python
+from ChaProEV import ChaProEV
+
+if __name__ == '__main__':
+    case_name: str = 'test_case'
+    ChaProEV.run_ChaProEV(case_name)
+```
+
+
 
 For examples of running ChaProEV and more configuration files,
 you can visit the [ChaProEV runs repository](https://github.com/TNO/ChaProEV_runs).

{chaproev-1.2.6 → chaproev-1.2.7}/README.md

@@ -13,7 +13,8 @@ This repository contains the ChaProEV (Charging Profiles of Electric Vehicles)
 model.
 
 ## Status
-The ChaProEV model is under construction and not yet ready for use.
+The ChaProEV model is currently released and useable. This version
+has been used in projects and can be used in future projects.
 Please contact the authors below if you have questions or requests to get
 model runs at some point.
 
@@ -61,7 +62,18 @@ To run the model, you need to put a ChaProEV.toml configuration
 in the folder where you run your model. You also need to have at least one scenario in your scenario/case_name (e.g. scenario/Mopo) folder. A
 If you want to create varaints, then you need to add a case.toml (e.g. Mopo.toml) file in the variants folder and put a variant file in the variants/case (e.g. variants/Mopo) folder. 
 If you want to compute fleet-level values and/or do a car owndriveway/street charging split, you need to put some files in the input/case (e.g. input/Mopo) folder.
-You can use the examples provided in this repository.
+You can use the examples provided in this repository. You can also
+unzip [this file](https://github.com/TNO/ChaProEV/blob/main/ChaProEV_test_case_configuration_files.zip)
+into your working folder and use 'test_case'  as your case name:
+```python
+from ChaProEV import ChaProEV
+
+if __name__ == '__main__':
+    case_name: str = 'test_case'
+    ChaProEV.run_ChaProEV(case_name)
+```
+
+
 
 For examples of running ChaProEV and more configuration files,
 you can visit the [ChaProEV runs repository](https://github.com/TNO/ChaProEV_runs).

chaproev-1.2.7/docs/consumption.md

@@ -0,0 +1,5 @@
+
+## create_consumption_tables
+
+### Source column
+[in the scenario](scenario.md#kilometers_column_for_consumption)

{chaproev-1.2.6 → chaproev-1.2.7}/docs/define.md

@@ -12,7 +12,7 @@ The parameters of a leg are:
 
 1. **Name:** The name of the leg
 2. **Vehicle:** The vehicle that runs the leg. If this does not correspond
-to the [scenario vehicle name](scenario.md#vehicle-name), then the leg is not
+to the [scenario vehicle name](scenario.md#name), then the leg is not
 declared.  Note that when running a
 scenario, you select one vehicle, so this is in principle not necessary.
 The reason for having this is to allow the user to copy the baseline file
@@ -40,7 +40,7 @@ The parameters of a location are:
 
 1. **Name**: The name of the location.
 2. **Vehicle:** The vehicle that uses the location. If this does not correspond
-to the [scenario vehicle name](scenario.md#vehicle-name), then the trip is not
+to the [scenario vehicle name](scenario.md#name), then the trip is not
 declared.  Note that when running a
 scenario, you select one vehicle, so this is in principle not necessary.
 The reason for having this is to allow the user to copy the baseline file
@@ -86,7 +86,7 @@ This value is set in the scenario files.
 ### Parameters
 1. **Name**: The name of the trip.
 2. **Vehicle:** The vehicle that does the trip. If this does not correspond
-to the [scenario vehicle name](scenario.md#vehicle-name), then the trip is not
+to the [scenario vehicle name](scenario.md#name), then the trip is not
 declared. Note that when running 
 a scenario, you select one vehicle, so this is in principle not necessary.
 The reason for having this is to allow the user to copy the baseline file
@@ -181,3 +181,11 @@ Have one trip per day type for non-cars
 
 Reference to day start hour
 cross-links with scenario
+
+
+## declare_class_instances
+
+
+## compute_travel_impact
+
+## get_trip_charging_sessions

chaproev-1.2.7/docs/general_parameters.md

@@ -0,0 +1,243 @@
+# Purpose
+The purpose of the ChaProEV.toml file is to set parameters
+that are common for all your scenarios.
+This page describes the various parameters.
+You can use the navigation bar on the left to go directly to a group
+of parameters (or a given parameter).
+This mostly contains general parameters that should not change too much from case to case. As such, you can take the version provided in the repository (and possibly modify one or two things).
+
+## variants
+The variants section of the configuration file sets parameters
+to create scenario [variants](variants.md) (see that page for
+details).
+
+### use_variants 
+Setting the use_variants parameters to true creates variants,
+while setting it to false skips variant creation althogether.
+
+### csv_version 
+
+Setting the csv_version to true parameters makes you use csv files
+to define your variants (in a folder within the variants folder: this
+folder needs to have the same name as your case). Setting it to false makes you use a toml file in the variants folder (case_name.toml).
+
+### use_years_in_profiles
+
+This is used to create different variants per year when doing 
+[car home own driveway and street parking splits](profiles.md#home-type-split)
+
+
+
+
+## parallel_processing
+This parallel processing section of the configuration file sets parameters to manage the [parallel processing/multiprocessing](multiprocessing.md) of the model (which reduces the model run time, see link for details).
+
+### set_amount_of_processes 
+
+Set this as false if you want the amount of parallel processes to be determined by the model (via the [multiprocessing standard library of Python](https://docs.python.org/3/library/multiprocessing.html)). Set this to true if you want to set the amount of processes yourself.
+
+### amount_for_scenarios
+
+If you put true in set_amount_of_processes, provide a number of parallel processes here to run scenarios in parallel.
+
+### amount_for_pickle_saves 
+If you put true in set_amount_of_processes, provide a number of parallel processes here to save the pickle output saves to other formats in parallel (see [writing module](writing.md) for details).
+
+## interim_files
+This concerns parameters for saving intermediary results to files.
+
+### pickle
+Set this to true to save interim results to pickle files.
+Set this to false not to do this.
+### consumption_tables_frequencies
+ Provide a list of consumption
+tables frequencies (see [consumption module](consumption.md)). The default is the following list ['hourly', 'daily', 'weekly', 'monthly', 'yearly']
+### save_consumption_table
+Provide a list of booleans (true or false) to save a given frequency to file (this list needs to have the same length as the above list): true save a file for that frequency and false does not.
+
+
+
+
+## profile_dataframe
+These are the headers that appear in output dataframes.
+
+### headers
+This one is for profiles (at one-vehicle scale).
+### fleet_headers
+This one is for the fleet-level dataframes.
+### do_fleet_tables
+Set this to true to create fleet-level tables.
+### fleet_file_name
+The file name (has to be a csv inside the input/your_case folder)
+containing the fleet characteristics.
+See [here](input.md#fleets) for details about this file.
+
+## sessions_dataframe
+This is to create the session dataframes.
+### properties
+Those are the quantities we want to put in the session dataframes.
+### dataframe_headers
+Those are the headers of the session dataframes at the day level.
+### run_dataframe_headers
+Those are the headers of the session dataframes for the whole run.
+### display_dataframe_headers
+These are the headers of the display/final output dataframe headers at vehicle level.
+### display_dataframe_index
+These give the index of the display/final output dataframe headers.
+### fleet_display_dataframe_headers
+These are the headers of the display/final output dataframe headers at fleet
+level.
+## plots
+This contains parameters for output plots (colors, styles, sizes, etc.).
+### vehicle_temperature_efficiency
+This set of parameters is for the [range-temperature](weather.md#range-and-temperature) plot.
+#### style
+This is a string with one of the [available Matplotlib styles](https://matplotlib.org/stable/gallery/style_sheets/style_sheets_reference.html).
+#### source_data_folder
+Folder where the data to plot is.
+#### source_data_file 
+File containg the data to plot.
+#### fit_color 
+The color name of fit line.
+#### fit_line_size
+The size of the fir line.
+#### geotab_data_color
+The color of the data points. 
+#### geotab_data_size
+The size of the data points.
+#### title_size 
+The size of the plot title.
+
+## files
+General file parameters.
+### input_root
+The name of the folder where your input data goes (it goes to a subfolder of this with the name of your case).
+### output_root
+The name of the folder where your output data goes (it goes to a subfolder of this with the name of your case).
+### groupfile_root
+This is for files that group data (such as (sqlite) databases or Excel workbooks) and will be the name of that grouping file.
+
+### figures
+Parameters for plots/figures.
+#### dpi
+Change this to change the resolution of the output figures.
+#### outputs
+Indicate  if you want to save your (Matplotlib) figures (true if you do, false if you don't) in various formats.
+
+
+### dataframe_outputs
+Indicate if you want to save your Pandas DataFrames in the
+listed formats (put a true if you want to do so, false if you don't).
+Clipboard saves to the local clipboard, not a file.
+
+## maps
+Parameters for making maps.
+## map_data_folder
+The folder where the map data is.
+## area_data_file_name
+The file containing map areas.
+## general_exclusion_codes
+Excluded map codes.
+## border_data_file_prefix
+The prefix of the border data file.
+## border_data_file_suffix
+The suffix of the border data file.
+## points_data_file_prefix
+The prefix of the points data file.
+## points_data_file_suffix
+The suffix of the points data file.
+## country_code_header
+The header we use for country codes.
+## country_code_header_in_map_data
+The country code header in tnhe source data.
+## heat_bar_map
+The heat bar map/scale we want to use for maps (is the name of a 
+[color bar](#color_bars)).
+
+## colors
+Definitions of custom colors (with RGB values, from 0 to 255).
+## color_bars
+You can deine color bars here, by listing the colors they use (in order).
+
+
+## unit_conversions
+This contains various constants used for unit conversions,
+such as the amount of Joules in a kiloWatt-hour.
+Some are grouped (time conversions).
+The times subpart also contains the codes for weekend day numbers
+and the index of the first hour in the year (often 0,
+but sometimes 1, as for the SPINE toolbox).
+## numbers
+This contains a threshold to avoid issues with float precision and exteremely small values that are actually zero.
+
+## consumption
+This contains settings (mostly headers and display names) related to
+the [connusmption](consumption.md) tables.
+### energy_carriers
+A list of the energy carriers that come in the consumption table.
+### consumption_table_name
+The name of the consumption table.
+### time_header
+The header used for the time index in the consumption table.
+### distance_header
+The header used for the distance column in the consumption table.
+### fleet_distance_header
+The header used for the distance column in the fleet consumption table.
+### energy_carriers_consumption_names
+The headers for each emergy carrier in the consumption table. 
+### fleet_energy_carriers_consumption_names
+The headers for each emergy carrier in the fleet consumption table.
+
+## home_type
+These are parametrers related to the [home type split](profiles.md#home-type-split) (split for cars between cars with their own driveway and street parking).
+### do_car_home_type_split
+Set this to true to compute the split. Set it to false not to do it.
+### percentages_file
+The file name (has to be a csv inside the input/your_case folder)
+containing the spli.
+See [here](input.md#car-own-driveway-percentage) for details about this file.
+
+### index_name
+The index header in the source file.
+
+### own_driveway_name
+The header for the own driveway percentage. Also used for the output profile file names.
+### on_street_name
+The header for the street parking percentage. Used for the output profile file names.
+### profiles_index
+The index for the profile outputs.
+### sessions_index
+The index for the sessions outputs.
+### sessions_values_columns
+The columns of the sessions dataframes.
+
+## sessions
+Parameters used for the [sessions](profiles.md#sessions).
+### produce
+Set to true if you want to create  [sessions](profiles.md#sessions), to
+false if you don't.
+
+### generate_profiles
+Set to true if you want to [generate profiles from sessions][scenarios_module.md#Generate-profiles-from-sessions], to false if you don't.
+## standard_profiles
+
+### produce
+Set to true if you want to produce [standard charging profiles](profiles.md#standard-profiles), false if you don't.
+
+## progress_bars
+Parameters related to displaying progress bars.
+### display_scenario_run
+Set to true to show a progress bar for the computing of scenarios, false if you don't.
+### scenario_run_description
+Text to display for the scenarios progress bar.
+### display_saving_pool_run
+Set to true to show a progress bar for the saving of output files, false if you don't.
+### saving_pool_run_description
+Text to display for the output file saving progress bar.
+
+## discharge
+Parameters related to vehicle discharge.
+### no_discharge_efficiency_output
+Message to display if the discharge efficiencncy value is empty.
+### no_charge_efficiency_output
+Message to display if the charge efficiencncy value is empty.

chaproev-1.2.7/docs/index.md

@@ -0,0 +1,9 @@
+# ChaProEV
+
+
+Test
+## More
+
+## Even more
+
+## **List of relevant files and modules**

chaproev-1.2.7/docs/input.md

@@ -0,0 +1,5 @@
+
+# Introduction
+
+# Car own driveway percentage
+# Fleets

chaproev-1.2.7/docs/mobility.md

@@ -0,0 +1,19 @@
+# Mobility
+
+
+## Module parameters
+
+## get_trip_probabilities_per_day_type
+
+### get_trip_probabilities_per_day_type_other_vehicles
+### get_car_trip_probabilities_per_day_type
+
+## compute_start_location_split
+
+
+## make_mobility_data
+### Weighted quantities
+
+## get_day_type_start_location_split
+
+## get_run_mobility_matrix

chaproev-1.2.7/docs/multiprocessing.md

@@ -0,0 +1,22 @@
+
+
+uses several cores at the same time
+
+
+
+```python
+    scenarios: ty.List[ty.Dict] = load_scenarios(case_name)
+
+    number_of_parallel_processes: int = general_parameters[
+        'parallel_processing'
+    ]['number_of_parallel_processes']['for_scenarios']
+    with Pool(number_of_parallel_processes) as scenarios_pool:
+        scenarios_pool.starmap(
+            run_scenario,
+            zip(scenarios, repeat(case_name), repeat(general_parameters)),
+        )
+```
+
+speeds up considerably 
+
+set this as false if you want the amount of parallel processes to be determined by the model (via the [multiprocessing standard library of Python](https://docs.python.org/3/library/multiprocessing.html)

chaproev-1.2.7/docs/profiles.md

@@ -0,0 +1,10 @@
+# Approach
+
+## Home type split
+vbmn
+
+## Sessions
+hhgjh
+
+## Standard profiles
+ghjkg