Skip to content

Commit

Permalink
Update docs and readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
SamTov committed Dec 20, 2021
1 parent dcdfa9f commit 6c42c8c
Show file tree
Hide file tree
Showing 5 changed files with 62 additions and 6 deletions.
21 changes: 21 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,27 @@ It can therefore be installed using pip with:
pip install znvis
If you prefer to access the source code, run the following from a terminal:

.. code-block:: bash
git clone https://github.com/zincware/ZnVis.git
cd ZnVis
pip install .
Once complete, you will be able to start using the visualizer by importing it as:

.. code-block:: python
import znvis
Known limitations
^^^^^^^^^^^^^^^^^
Currently it seems that for medium sized systems (400 particles) running the visualizer
can result in a memory failure after a while.
We are working on how to extend ZnVis to arbitrary sized systems.


.. badges
.. |madewithpython| image:: https://img.shields.io/badge/Made%20With-Python-blue.svg?style=flat
Expand Down
2 changes: 1 addition & 1 deletion docs/source/_developer_docs/developer_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Developer documentation
Welcome to the developer documentation.

.. toctree::
:maxdepth: 1
:maxdepth: 2
:caption: Overview:

_modules/modules.rst
2 changes: 1 addition & 1 deletion docs/source/_user_guide/user_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ in an attempt to guide new users through the ZnVis code.
It is recommended that you start with the simple spheres page and work your way down.

.. toctree::
:maxdepth: 1
:maxdepth: 2
:caption: Example guides:

simple_spheres
Expand Down
25 changes: 24 additions & 1 deletion docs/source/_welcome_guide/getting_started.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,25 @@
Getting started with ZnVis
--------------------------
--------------------------

The first steps to using ZnVis is the installation.
If you are using pip, it is a simple as:

.. code-block:: bash
pip install znvis
If you wish to install ZnVis from source, you may simply run the following:

.. code-block:: bash
git clone https://github.com/zincware/ZnVis.git
cd ZnVis
pip install .
Once complete, you will be able to start using the visualizer by importing it as:

.. code-block:: python
import znvis
With installation out of the way, head over to the example guides and start visualizing.
18 changes: 15 additions & 3 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,23 +1,35 @@
ZnVis Documentation
-------------------

Welcome to the documentation of ZnVis.
ZnVis is a Python packaged built on the
:ref:`Open3D <http://www.open3d.org/docs/release/index.html>`_ framework for the
visualization of particle data.
Currently ZnVis is capable of rendering spheres, cylinders, and custom .stl files but
more shapes are expected soon.

.. toctree::
:maxdepth: 1
:maxdepth: 2
:caption: Welcome Guide:

_welcome_guide/getting_started


.. toctree::
:maxdepth: 1
:maxdepth: 2
:caption: User Guide:

_user_guide/user_guide


.. toctree::
:maxdepth: 1
:maxdepth: 2
:caption: Developer Guide:

_developer_docs/developer_guide

Known limitations
^^^^^^^^^^^^^^^^^
Currently it seems that for medium sized systems (400 particles) running the visualizer
can result in a memory failure after a while.
We are working on how to extend ZnVis to arbitrary sized systems.

0 comments on commit 6c42c8c

Please sign in to comment.