generated from rl-institut/rli_template
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #335 from rl-institut/features/update_tabular
Features/update tabular
- Loading branch information
Showing
24 changed files
with
979 additions
and
654 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -29,15 +29,33 @@ In the documentation you will find instructions on how to run the scenarios with | |
|
||
### Installation | ||
|
||
Currently, oemof-B3 needs python 3.7 or 3.8 (newer versions may be supported, but installation can take very long). | ||
Currently, oemof-B3 needs python 3.8, 3.9 or 3.10 (newer versions may be supported, but installation can take very long). | ||
|
||
In order to install oemof-B3, proceed with the following steps: | ||
Additionally, you need to install the python dependency manager [poetry](https://python-poetry.org/). | ||
It is recommended to install poetry system-wide via the command below or | ||
[pipx](https://python-poetry.org/docs/#installing-with-pipx): | ||
|
||
- git-clone oemof-B3 into local folder: `git clone https://github.com/rl-institut/oemof-B3.git` | ||
- enter folder | ||
- create virtual environment using conda: `conda env create environment.yml` | ||
- activate environment: `conda activate oemof-B3` | ||
- install oemof-B3 package using poetry, via: `poetry install` | ||
curl -sSL https://install.python-poetry.org | python3 - | ||
poetry install | ||
|
||
|
||
**In order to install oemof-B3, proceed with the following steps:** | ||
|
||
1. Clone oemof-B3 into local folder: | ||
|
||
git clone [email protected]:rl-institut/oemof-B3.git | ||
2. Enter folder | ||
|
||
cd oemof-B3 | ||
3. Create virtual environment using conda: | ||
|
||
conda env create environment.yml | ||
4. Activate environment: | ||
|
||
conda activate oemof-B3 | ||
5. Install oemof-B3 package using poetry, via: | ||
|
||
poetry install | ||
|
||
Alternatively, you can create a virtual environment using other approaches, such as `virtualenv`. | ||
|
||
|
@@ -46,7 +64,7 @@ If environment is build otherwise, pandoc must be installed manually. It can be | |
|
||
For the optimization, oemof-B3 needs a solver. Check out the [oemof.solph](https://oemof-solph.readthedocs.io/en/latest/readme.html#installing-a-solver) documentation for installation notes. | ||
|
||
To test if everything works, you can run the examples (cf. :ref:`How to run the model`). | ||
To test if everything works, you can run the [examples](https://oemof-b3.readthedocs.io/en/latest/examples.html). | ||
|
||
For developers: Please activate pre-commit hooks (via `pre-commit install`) in order to follow our coding styles. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,15 +11,49 @@ Using oemof-B3 | |
Installation | ||
------------ | ||
|
||
Currently, oemof-B3 needs python 3.7 or 3.8 (newer versions may be supported, but installation can take very long). | ||
Currently, oemof-B3 needs python 3.8, 3.9 or 3.10 (newer versions may be supported, but installation can take very long). | ||
|
||
In order to install oemof-B3, proceed with the following steps: | ||
Additionally, you need to install the python dependency manager `poetry <https://python-poetry.org/>`_. | ||
It is recommended to install poetry system-wide via the command below or | ||
`pipx <https://python-poetry.org/docs/#installing-with-pipx>`_: | ||
|
||
- git-clone oemof-B3 into local folder: `git clone https://github.com/rl-institut/oemof-B3.git` | ||
- enter folder | ||
- create virtual environment using conda: `conda env create environment.yml` | ||
- activate environment: `conda activate oemof-B3` | ||
- install oemof-B3 package using poetry, via: `poetry install` | ||
:: | ||
|
||
curl -sSL https://install.python-poetry.org | python3 - | ||
poetry install | ||
|
||
|
||
**In order to install oemof-B3, proceed with the following steps:** | ||
|
||
1. Clone oemof-B3 into local folder: | ||
|
||
:: | ||
|
||
git clone [email protected]:rl-institut/oemof-B3.git | ||
|
||
2. Enter folder | ||
|
||
:: | ||
|
||
cd oemof-B3 | ||
|
||
3. Create virtual environment using conda: | ||
|
||
:: | ||
|
||
conda env create environment.yml | ||
|
||
4. Activate environment: | ||
|
||
:: | ||
|
||
conda activate oemof-B3 | ||
|
||
5. Install oemof-B3 package using poetry, via: | ||
|
||
:: | ||
|
||
poetry install | ||
|
||
Alternatively, you can create a virtual environment using other approaches, such as `virtualenv`. | ||
|
||
|
@@ -163,7 +197,7 @@ of the componentes in the subdirectory oemof_b3 can be done. | |
But you can also modify oemof_b3 to define your own energy system of another city or district. | ||
For all these use cases, the data in the raw directory | ||
must be adapted. For this purpose, it is advisable to have energy system-specific empty scalar data | ||
and time series created for each scenario. | ||
and time series created for each scenario. See further information in :ref:`How to customize oemof-B3`. | ||
|
||
Executing the rule | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
examples/example_base/preprocessed/data/elements/electricity-shortage.csv
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
region,name,type,carrier,tech,bus,capacity,marginal_cost,output_parameters | ||
BE,BE-electricity-shortage,shortage,electricity,shortage,BE-electricity,,100000,{} | ||
BB,BB-electricity-shortage,shortage,electricity,shortage,BB-electricity,,100000,{} | ||
BE,BE-electricity-shortage,shortage,electricity,shortage,BE-electricity,10000000,410,{} | ||
BB,BB-electricity-shortage,shortage,electricity,shortage,BB-electricity,10000000,410,{} |
4 changes: 2 additions & 2 deletions
4
examples/example_more_re/preprocessed/data/elements/electricity-shortage.csv
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
region,name,type,carrier,tech,bus,capacity,marginal_cost,output_parameters | ||
BE,BE-electricity-shortage,shortage,electricity,shortage,BE-electricity,,100000,{} | ||
BB,BB-electricity-shortage,shortage,electricity,shortage,BB-electricity,,100000,{} | ||
BE,BE-electricity-shortage,shortage,electricity,shortage,BE-electricity,10000000,410,{} | ||
BB,BB-electricity-shortage,shortage,electricity,shortage,BB-electricity,10000000,410,{} |
4 changes: 2 additions & 2 deletions
4
examples/example_more_re_less_fossil/preprocessed/data/elements/electricity-shortage.csv
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
region,name,type,carrier,tech,bus,capacity,marginal_cost,output_parameters | ||
BE,BE-electricity-shortage,shortage,electricity,shortage,BE-electricity,,100000,{} | ||
BB,BB-electricity-shortage,shortage,electricity,shortage,BB-electricity,,100000,{} | ||
BE,BE-electricity-shortage,shortage,electricity,shortage,BE-electricity,10000000,410,{} | ||
BB,BB-electricity-shortage,shortage,electricity,shortage,BB-electricity,10000000,410,{} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.