To receive notifications about scheduled maintenance, please subscribe to the mailing-list gitlab-operations@sympa.ethz.ch. You can subscribe to the mailing-list at https://sympa.ethz.ch

Commit 5243f57f authored by Xuqian Yan's avatar Xuqian Yan
Browse files

Minor changes about readme, gurobi; added placeholder for input data modification

parent d5e9e659
......@@ -10,5 +10,6 @@ An integrated energy systems modelling platform | `nexus-e.org <http://nexus-e.o
setup.md
euler_instruction.md
nexuse_repo_instruction.md
modify_input_data.md
connect_new_module.md
faq.md
\ No newline at end of file
### **Modify input data**
#### Section aaa
#### Section bbb
- bullet point 1
- bullet point 1.1
......@@ -126,7 +126,6 @@ You could skip this section if you don't plan to run the whole Nexus-e platform
```
- Python packages: install the required packages listed in `requirements.txt`.
- Gurobi (9.x): Download gurobi and set up a free Gurobi academic license <https://www.gurobi.com/academia/academic-program-and-licenses>
- Python path: If you use Mac or if you want to run Nexus-e in a python virtual environment, you need to configure Python path in Matlab. Otherwise, you could skip this step.
- Make a copy of `user_example_conf.m` in the folder `Run_Nexuse`. Name the copy as `user_conf.m`. (Note: You should only work with the local copy, because the original `xxx_example_conf.m` will be synchronized to git and it shouldn't be changed.)
- Find out your python path (it varies largely depending on your PC's operating system and how you installed python). Uncomment and adapt the variable `PATH_PYTHON` in `user_conf.m` accordingly.
......@@ -140,7 +139,10 @@ You could skip this section if you don't plan to run the whole Nexus-e platform
- GAMS path
- If you haven't done so, make a copy of `user_example_conf.m` in the folder `Run_Nexuse`. Name the copy as `user_conf.m`. (Note: You should only work with the local copy, because the original `xxx_example_conf.m` will be synchronized to git and it shouldn't be changed.)
- Find out your GAMS path (it varies largely depending on your PC's operating system and the version of GAMS). Uncomment and adapt the variable `PATH_GAMS` in `user_conf.m` accordingly.
- **Gurobi**(9.x)
- Download Gurobi and set up a free Gurobi academic license <https://www.gurobi.com/academia/academic-program-and-licenses>.
- Connect Gurobi with Matlab following [this instruction](https://www.gurobi.com/documentation/9.0/quickstart_mac/matlab_setting_up_grb_for_.html).
##### 4. Run Nexus-e
......@@ -298,6 +300,8 @@ But still, we need to explicitely load all the dependencies, including modules (
##### 5. Run Nexus-e
- cd to the `Run_Nexuse` folder
- Before running `run_Nexuse.m` for the first time, you need to run `bench_Nexuse.m`.
It is recommended to repeat this step after major changes to the modules eMark and CentIv.
- Submit the job with a command such as
```
bsub -n 36 -R "model==XeonGold_6150" -R "rusage[mem=5180]" -W "10:00" matlab -r run_Nexuse
......
How to compile the whole documentation locally:
- install python 3.x
- pip install sphinx
- pip install recommonmark
- pip install sphinxemoji
- cd to nexuse-doc/docs
- make html
- open build/html/index.html
- Webpage will be shown in the browser
\ No newline at end of file
- Webpage will be shown in the browser
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment