Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

jupyter-notebook dependency #41

Merged
merged 18 commits into from
Feb 1, 2022
6 changes: 6 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@

# Changelog

## Version 1.0.2

**Bug fixes**

* Correct dependency name for jupyter-notebook
* Move jupyter-notebook to base install dependecy

## Version 1.0.1

Expand Down
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,12 @@ pip install wecopttool

## Tutorials
The tutorials can be found in the `examples` directory and are written as [Jupyter Notebooks](https://jupyter.org/).
There are many ways to interact with Jupyter Notebooks.
To run the notebooks on your local machine, first install the classical Jupyter Notebook locally:

```bash
pip install notebook
```

To run the tutorials, from the directory containing the notebooks run
To run the tutorials, first download the notebook files and then, from the directory containing the notebooks, run `jupyter notebook`.
Using `git` to obtain the notebooks this can be done by running

```bash
git clone https://github.com/SNL-WaterPower/WecOptTool.git
cd WecOptTool/examples
jupyter notebook
```

Expand Down
6 changes: 2 additions & 4 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ install_requires =
xarray
autograd
capytaine>=1.3
pygmsh
netCDF4
meshio
gmsh
pygmsh
# meshmagick
jupyter

[options.extras_require]
dev =
Expand All @@ -38,13 +38,11 @@ dev =
sphinx_rtd_theme
nbsphinx
pandoc
notebook
imageio
doc =
sphinx
sphinxcontrib-bibtex
sphinx_rtd_theme
nbsphinx
pandoc
notebook
imageio