Metadata-Version: 2.3
Name: rivtlib
Version: 1.0.0a3
Summary: a package for editing and formatting 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-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.10.1
Requires-Dist: pyzo>=4.20.0
Requires-Dist: github-clone>=1.2.0
Requires-Python: >=3.13
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 a number of bugs
still exist in the program.**

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 add to complexity when assembling 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
formatted *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>`__.

*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

