diff --git a/docs/citing.rst b/docs/acknowledgements.rst similarity index 96% rename from docs/citing.rst rename to docs/acknowledgements.rst index 775bd7aa4..91bec0618 100644 --- a/docs/citing.rst +++ b/docs/acknowledgements.rst @@ -1,10 +1,10 @@ ******************************************************************************** -Citing +Acknowledgements ******************************************************************************** .. rst-class:: lead - If you use ``compas_tna`` in your work, please cite one of the references below. +If you use ``compas_tna`` in your work, please cite one of the references below. Code ==== diff --git a/docs/index.rst b/docs/index.rst index 7ca55f76e..002230bbb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -26,4 +26,4 @@ Table of Contents tutorial api license - citing + acknowledgements diff --git a/docs/installation.rst b/docs/installation.rst index 38bbe0c0c..8f7bc7298 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -22,3 +22,15 @@ The latest version can be installed from local source. git clone https://github.com/blockresearchgroup/compas_tna.git cd compas_tna pip install -e . + + +Development +=========== + +To install `compas_tna` for development, install from local source with the "dev" requirements. + +.. code-block:: bash + + git clone https://github.com/blockresearchgroup/compas_tna.git + cd compas_tna + pip install -e ".[dev]" diff --git a/docs/tutorial.rst b/docs/tutorial.rst index 45169cc77..9c2a712de 100644 --- a/docs/tutorial.rst +++ b/docs/tutorial.rst @@ -2,22 +2,4 @@ Tutorial ******************************************************************************** -Currently, we only have a basic tutorial in the form of interactve notebooks. -To run the notebooks you need to clone the repo and install the package requirements. - -.. code-block:: bash - - $ git clone https://github.com/blockresearchgroup/compas_tna.git - $ cd compas_tna - $ pip install -r requirements-dev.txt - - -Notebooks can be used directly in VS Code, or in the browser using Jupyter. -To start the Jupyter server, run the following command in a terminal - -.. code-block:: bash - - $ jupyter notebook - - -Or use `this binder `_ to try out the functionality wihtout installing anything. +Coming soon ... \ No newline at end of file