Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tomvanmele committed Feb 29, 2024
1 parent 49aead4 commit f73ea58
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 22 deletions.
4 changes: 2 additions & 2 deletions docs/citing.rst → docs/acknowledgements.rst
Original file line number Diff line number Diff line change
@@ -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
====
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ Table of Contents
tutorial
api
license
citing
acknowledgements
12 changes: 12 additions & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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]"
20 changes: 1 addition & 19 deletions docs/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://mybinder.org/v2/gh/blockresearchgroup/compas_tna/main?urlpath=lab/tree/notebooks>`_ to try out the functionality wihtout installing anything.
Coming soon ...

0 comments on commit f73ea58

Please sign in to comment.