diff --git a/CHANGES.md b/CHANGES.md index 8450523a..03295a42 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -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 diff --git a/README.md b/README.md index fe31a737..5b96c88c 100644 --- a/README.md +++ b/README.md @@ -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 ``` diff --git a/setup.cfg b/setup.cfg index e48ba6b1..c36d8695 100644 --- a/setup.cfg +++ b/setup.cfg @@ -24,11 +24,11 @@ install_requires = xarray autograd capytaine>=1.3 + pygmsh netCDF4 meshio gmsh - pygmsh - # meshmagick + jupyter [options.extras_require] dev = @@ -38,7 +38,6 @@ dev = sphinx_rtd_theme nbsphinx pandoc - notebook imageio doc = sphinx @@ -46,5 +45,4 @@ doc = sphinx_rtd_theme nbsphinx pandoc - notebook imageio