Skip to content

Commit

Permalink
Added extra information and styled
Browse files Browse the repository at this point in the history
  • Loading branch information
Saransh-cpp committed Feb 4, 2021
1 parent 48dc563 commit 3c66c6e
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ pipx install tox # (Using this, tox can automatically be accessed in your virtau
3. Installing PyBaMM

This can be acieved by forking the repository and cloning it in your machine.

4. Navigate to the clonned repository and create a virtual environment using the commands below:
```bash
tox -e dev # (GNU/Linux and MacOS)
Expand All @@ -72,7 +73,9 @@ python -m tox -e windows-dev # (Windows)
This will

a. Create a virtual environment located at `.tox/dev`.

b. Install all the dependencies for PyBaMM, including the ones for documentation and development.

c. Tell Python to use your local pybamm files when you use `import pybamm` anywhere on your system.

5. Finally, activate your environment.
Expand Down Expand Up @@ -109,6 +112,11 @@ Or type:
pip install pybamm
```

Additionally you can install sundials on mac using:
```bash
brew install sundials
```


Full documentation with an installation guide can be found [here](https://pybamm.readthedocs.io/en/latest/)

Expand Down

0 comments on commit 3c66c6e

Please sign in to comment.