Skip to content

Commit acacf34

Browse files
Update develop.md
1 parent 5f72ff3 commit acacf34

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/develop.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ email, or any other method with the owners of this repository before making a ch
55

66
Please note we have a code of conduct, please follow it in all your interactions with the project.
77

8-
# Setup
8+
## Setup
99

1010
There are multiple different approaches to developing for EMHASS.
1111
The choice depends on your and preference (Python venv/DevContainer/Docker).
1212
Below are some development workflow examples:
1313
_Note: It is preferred to run the actions and unittest once before submitting and pull request._
1414

15-
## Step 1 - Fork
15+
### Step 1 - Fork
1616

1717
_With your preferred Git tool of choice:_
1818
Fork the EMHASS github repository into your own account, then clone the forked repository into your local development platform. (ie. PC or Codespace)
@@ -27,11 +27,11 @@ cd emhass
2727
git remote add upstream https://github.com/davidusb-geek/emhass.git
2828
```
2929

30-
## Step 2 - Develop
30+
### Step 2 - Develop
3131

3232
To develop and test code choose one of the following methods:
3333

34-
### Method 1 - Python Virtual Environment
34+
#### Method 1 - Python Virtual Environment
3535

3636
We can use python virtual environments to build, develop and test/unittest the code.
3737

@@ -106,7 +106,7 @@ emhass --action 'dayahead-optim' --config ./config.json --root ./src/emhass --co
106106
pytest
107107
```
108108

109-
### Method 2: VS-Code Debug and Run via Dev Container
109+
#### Method 2: VS-Code Debug and Run via Dev Container
110110

111111
In VS-Code, you can run a Docker Dev Container to set up a virtual environment. The Dev Container's Container will be almost identical to the one build for EMHASS (Docker/Add-on). There you can edit and test EMHASS.
112112

@@ -233,7 +233,7 @@ docker build -t emhass/test --build-arg build_version=addon-local .
233233
docker run -it -p 5000:5000 --name emhass-test -e EMHASS_KEY -e EMHASS_URL -e TIME_ZONE -e LAT -e LON -e ALT emhass/test
234234
```
235235

236-
### Example Docker testing pipeline
236+
#### Example Docker testing pipeline
237237
The following pipeline will run unittest and most of the EMHASS actions. This may be a good option for those who wish to test their changes against the production EMHASS environment.
238238

239239
*Linux:*
@@ -284,7 +284,7 @@ docker exec emhass-test python3 -m unittest discover -s ./tests -p 'test_*.py' |
284284
User may wish to re-test with tweaked parameters such as `lp_solver`, `weather_forecast_method` and `load_forecast_method`, in `config.json` to broaden the testing scope.
285285
*See [Differences](https://emhass.readthedocs.io/en/latest/differences.html) for more information on how the different methods of running EMHASS differ.*
286286

287-
### Adding a parameter
287+
#### Adding a parameter
288288
When enhancing EMHASS, users may like to add or modify the EMHASS parameters. To add a new parameter see the following steps:
289289

290290
*Example parameter = `this_parameter_is_amazing`*
@@ -340,7 +340,7 @@ If you are only adding another option for a existing parameter, editing param_de
340340
},
341341
```
342342

343-
## Step 3 - Pull request
343+
### Step 3 - Pull request
344344

345345
Once developed, commit your code, and push the commit to your fork on Github.
346346
Once ready, submit a pull request with your fork to the [davidusb-geek/emhass@master](https://github.com/davidusb-geek/emhass) repository.

0 commit comments

Comments
 (0)