Skip to content

Commit

Permalink
Merge pull request #366 from inbo/ch-doc-running
Browse files Browse the repository at this point in the history
Documentation: add separate "running niche" item
  • Loading branch information
cecileherr committed Jan 12, 2024
2 parents 3703771 + 4df7cfd commit 123c5da
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 28 deletions.
3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,9 @@ Deze documentatie bestaat uit **twee delen**:
:maxdepth: 2

installation
codetables
running
tutorials
codetables
cli
lowlevel
faq
Expand Down
27 changes: 0 additions & 27 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,30 +110,3 @@ will not work) and `jupyter` notebook, which allows interactive usage from a web
conda install matplotlib jupyter
Running niche
=============

Whenever you want to use niche_vlaanderen (either from the command line or Python) you need
to start from the `Anaconda prompt` (in the start menu)
and activate the environment:

.. code-block:: shell
(C:\Users\myusername\Miniconda3) C:\Users\myusername> conda activate niche
Optionally - Jupyter Notebook
=============================

If you want to run niche_vlaanderen interactively, we recommend using a [jupyter notebook](http://jupyter.org/).
To run this, from the `Anaconda prompt` do:

.. code-block:: default
(C:\Users\myusername\Miniconda3) C:\Users\myusername> conda activate niche
(niche) C:\Users\myusername> jupyter notebook
This should open a webbrowser pointing towards http://localhost:8888 . If your browser does not open, try looking for the correct URL at the `Anaconda prompt`.

The :doc:`tutorials` will use these jupyter notebooks, and are the best place to continue from here.


28 changes: 28 additions & 0 deletions docs/running.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
##############
Running niche
##############

Whenever you want to use niche_vlaanderen (either from the command line or Python) you need
to start from the `Anaconda/Miniconda prompt` (in the start menu)
and activate the environment (in this example, an environment you called `niche` during the installation):

.. code-block:: shell
(C:\Users\myusername\Miniconda3) C:\Users\myusername> conda activate niche
Optionally - Jupyter Notebook
=============================

If you want to run niche_vlaanderen interactively, we recommend using a [jupyter notebook](http://jupyter.org/).
To run this, from the `Anaconda/Miniconda prompt` do:

.. code-block:: default
(C:\Users\myusername\Miniconda3) C:\Users\myusername> conda activate niche
(niche) C:\Users\myusername> jupyter notebook
This should open a webbrowser pointing towards http://localhost:8888 . If your browser does not open, try looking for the correct URL at the `Anaconda prompt`.

The :doc:`tutorials` will use these jupyter notebooks, and are the best place to continue from here.


0 comments on commit 123c5da

Please sign in to comment.