Skip to content

Commit

Permalink
Merge pull request #988 from pybamm-team/issue987_mv_install_to_doc
Browse files Browse the repository at this point in the history
Move install instructions to documentation
  • Loading branch information
tlestang authored May 12, 2020
2 parents 38e142b + 97f172c commit 747be3a
Show file tree
Hide file tree
Showing 10 changed files with 716 additions and 507 deletions.
163 changes: 0 additions & 163 deletions INSTALL-LINUX-MAC.md

This file was deleted.

89 changes: 0 additions & 89 deletions INSTALL-WINDOWS-WSL.md

This file was deleted.

54 changes: 0 additions & 54 deletions INSTALL-WINDOWS.md

This file was deleted.

27 changes: 16 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,19 +49,24 @@ can be found

For further examples, see the list of repositories that use PyBaMM [here](https://github.com/pybamm-team/pybamm-example-results)

## How can I obtain & install PyBaMM?

### Linux

For instructions on installing PyBaMM on Debian-based distributions, please see [here](INSTALL-LINUX-MAC.md).

### Mac OS

For instructions on installing PyBaMM on Mac OS distributions, please see [here](INSTALL-LINUX-MAC.md).
## How can I install PyBaMM?
PyBaMM is available on GNU/Linux, MacOS and Windows.
We strongly recommend to install PyBaMM within a python virtual environment, in order not to alter any distribution python files.
For instructions on how to create a virtual environment for PyBaMM, see [the documentation](https://pybamm.readthedocs.io/en/latest/install/GNU-linux.html#user-install).

### Using pip
```bash
pip install pybamm
```

### Windows
### Using conda
PyBaMM is available as a conda package through the conda-forge channel.
```bash
conda install -c conda-forge pybamm
```

For instructions on installing PyBaMM on Windows distributions, please see [here](INSTALL-WINDOWS.md). If you want to install the optional solvers (such as scikits-odes and KLU solvers), install PyBaMM on the Windows Subsystem for Linux following the instructions [here](INSTALL-WINDOWS-WSL.md)
### Optional solvers
On GNU/Linux and MacOS, an optional [scikits.odes](https://scikits-odes.readthedocs.io/en/latest/)-based solver is available, see [the documentation](https://pybamm.readthedocs.io/en/latest/install/GNU-linux.html#scikits-odes-label).

## Citing PyBaMM

Expand Down
Loading

0 comments on commit 747be3a

Please sign in to comment.