From b31aaf88679dca7c40267a4d57be49dcd1b458d5 Mon Sep 17 00:00:00 2001 From: "pierre-francois.duc" Date: Tue, 4 Jun 2024 11:41:58 +0200 Subject: [PATCH] Fix README formatting So that twine check dist/* does not output errors. Pre-commit removed trailing spaces in the file as well --- README.rst | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index 216df0d..414a796 100644 --- a/README.rst +++ b/README.rst @@ -12,8 +12,7 @@ :alt: Documentation Status .. image:: https://coveralls.io/repos/github/RAMP-project/RAMP/badge.svg?branch=main -:target: https://coveralls.io/github/RAMP-project/RAMP?branch=main - + :target: https://coveralls.io/github/RAMP-project/RAMP?branch=main .. image:: https://github.com/RAMP-project/RAMP/blob/main/docs/source/_static/RAMP_logo_basic.png?raw=true :width: 300 @@ -110,7 +109,7 @@ To have a look to the python files, you can download them using the `download_ex download_example("the specfic folder directory to save the files") -- ``input_file_1.py``: represents the most basic electric appliances; it is +- ``input_file_1.py``: represents the most basic electric appliances; it is an example of how to model lightbulbs, radios, TVs, fridges, and other electric appliances. This input file is based on the ones used for `the first RAMP publication `__. @@ -267,7 +266,7 @@ we use a more compact formulation: random_var_w=0.35 # 35% randomness assigned to the size of the functioning windows ) -At this point, we can group our different users into a "use case" and run the simulation, +At this point, we can group our different users into a "use case" and run the simulation, for instance for a whole year. .. code-block:: python @@ -276,10 +275,10 @@ for instance for a whole year. whole_year_profile = use_case.generate_daily_load_profiles() Here is your first load for a community including two types of housholds, -for a total of 23 individual users. Of course, more variations and many more -features are possible! For instance, you can simulate loads even for -an individual appliance or user. In addition, you can use in-built plotting -functionalities to explore your results. Check out the documentation +for a total of 23 individual users. Of course, more variations and many more +features are possible! For instance, you can simulate loads even for +an individual appliance or user. In addition, you can use in-built plotting +functionalities to explore your results. Check out the documentation for all the possibilities. Contributing