-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
62 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |