Before you install any packages it is recommended that you create a virtual environment. You can do this using the built in venv module. It is also possible to use the virtualenv package which can be installed with pip.
$ python -m pip install virtualenv
Now create a virtual environment as follows:
$ python -m virtualenv venv
and activate the virtual environment. For unix users you can use
$ source venv/bin/activate
and Windows users can use
$ .\venv\Scripts\activate.bat
To install FEniCS-Plotly, run this command in your terminal:
$ pip install fenics-plotly
This is the preferred method to install FEniCS-Plotly, as it will always install the most recent stable release.
If you don't have pip installed, this Python installation guide can guide you through the process.
The sources for FEniCS-Plotly can be downloaded from the Github repo.
You can either clone the public repository:
$ git clone git@github.com:finsberg/fenics_plotly.git
Or download the tarball:
$ curl -OJL https://github.com/finsberg/fenics_plotly/tarball/master
Once you have a copy of the source, you can install it with:
$ python -m pip install .
There is also a way to install the package using the Makefile, i.e
$ make install
If you plan to develop this package you should also make sure to install the development dependencies listed in the [requirements_dev.txt]{.title-ref}. In addition you should also make sure to install the pre-commit hook. All of this can be installed by executing the command
$ make dev
Note that this will also install the main package in editable mode, which is nice when developing.