Metadata-Version: 2.3
Name: rivtlib
Version: 1.0.0a11
Summary: write, edit and share engineering documents
Author: rholland
Author-email: rholland <support@structurelabs.com>
Requires-Dist: tabulate>=0.9.0
Requires-Dist: fastcore>=1.8.16
Requires-Dist: pillow>=11.2.1
Requires-Dist: matplotlib>=3.10.1
Requires-Dist: sympy>=1.13.3
Requires-Dist: scipy>=1.16.3
Requires-Dist: numpy>=2.2.5
Requires-Dist: pandas>=2.2.3
Requires-Dist: docutils>=0.21.2
Requires-Dist: ipython>=8.16.2
Requires-Dist: ipykernel>=6.28.1
Requires-Dist: reportlab>=4.4.0
Requires-Dist: rst2pdf>=0.103.1
Requires-Dist: pypdf>=1.0.3
Requires-Dist: sphinx>=8.2.3
Requires-Dist: pydata-sphinx-theme>=0.16.1
Requires-Dist: sphinx-copybutton>=0.5.2
Requires-Dist: sphinx-design>=0.6.1
Requires-Dist: sphinx-favicon>=1.0.1
Requires-Dist: sphinx-new-tab-link>=0.8.1
Requires-Dist: sphinx-togglebutton>=0.3.2
Requires-Dist: sphinxcontrib-applehelp>=2.0.0
Requires-Dist: sphinxcontrib-devhelp>=2.0.0
Requires-Dist: sphinxcontrib-email>=0.3.6
Requires-Dist: sphinxcontrib-htmlhelp>=2.1.0
Requires-Dist: sphinxcontrib-jquery>=4.1
Requires-Dist: sphinxcontrib-jsmath>=1.0.1
Requires-Dist: sphinxcontrib-qthelp>=2.0.0
Requires-Dist: sphinxcontrib-serializinghtml>=2.0.0
Requires-Dist: pyside6>=6.8.0.2
Requires-Dist: pyzo>=4.20.0
Requires-Dist: github-clone>=1.2.0
Requires-Dist: rivtlib
Requires-Python: >=3.14
Project-URL: user manual, https://rivt.info
Project-URL: repository, https://github.com/rivtlib-dev/rivtlib
Project-URL: documentation, https://rivtlib.dev
Project-URL: changelog, https://github.com/rivtlib-dev/rivtlib/blob/main/CHANGELOG.md
Description-Content-Type: text/x-rst

rivtlib
========

**rivtlib is alpha software. Some features are not complete and the program has
a number of bugs.**

rivt is an open source software project that simplifies sharing and reuse of
engineering documents. This has always been a challenge because engineering
documents typically include text, images, tables, calculations, models
and computer code, which adds to complexity when assembling documents and 
reports.

The primary use case for rivt is producing engineering documents that lie
somewhere between back of envelope notes and calculations, and formal journal
publications. In other words, it produces formatted, organized documents that
are easy to edit.

The second use case is when flexibilty is needed to produce documents in a
variety of formats including text, PDF or HTML. A *rivt file* publishes a
*rivt doc* as a text, PDF or HTML file. A *rivt file* is a Python file
(.py) that imports the *rivtlib* Python package and includes rivt markup. A
collection of *rivt docs* may be linked and collated as a *rivt report*. The
*rivt user manual* is `here <https://rivt.info>`__.

Use Cases
-----------

*rivt files* can function as a front and back end for:

#. software control
#. visualization
#. instrumentation

*rivt docs* can be used for:

#. internal communication
#. research documentation
#. government permits
#. technical reports
#. funding applications

*rivt* is compatible with collaborative tools and may be used for:

#. teaching
#. presentations
#. real time collaboration

The table below summarizes and compares limitations between different software
programs. *rivt* is designed to address these limitations and serve as a
complement or replacement to existing software.


Software Comparison
--------------------

============ ========= ======== ======== ========= ========= ============= 
Program      Rep [1]_  Ver [2]_ Txt [3]_ Comp [4]_  CP [5]_   Collab [6]_  
============ ========= ======== ======== ========= ========= ============= 
Matlab         no       no         no      no          no       no   
Mathcad        no       no         no      no          no       no   
Mathematica    no       no         no      no          no       no   
Cloud SaaS    limited   no         no      no          yes      limited  
Excel         limited   no         no      yes         no       yes 
Jupyter        no       no         no      yes         yes      yes  
**rivt**      **yes**  **yes**   **yes**  **yes**   **yes**    **yes**
============ ========= ======== ======== ========= ========= ============= 


.. [1] Report generation
.. [2] Native version control
.. [3] Plain text, readable input files
.. [4] Forward and backward compatibility
.. [5] Cross-platform
.. [6] Collaboration support