Skip to content
Snippets Groups Projects
Commit fd06b796 authored by Ian Bell's avatar Ian Bell
Browse files

Reformat getting started

parent f4de5e0a
No related branches found
No related tags found
No related merge requests found
Getting Started
===============
Introduction Introduction
============ ------------
teqp is a C++-based library with wrappers. It was written because implementing EOS (particularly working out the derivatives) is a painful , error-prone, and slow process. The advent of automatic differentiation makes the implementation of EOS as fast as hand-written derivatives, and much easier to implement without errors.
teqp is a C++-based library with wrappers. The documentation is based on the Python wrapper because it can be readily integrated with the documentation tools and can be auto-generated at documentation build time. The documentation is based on the Python wrapper because it can be readily integrated with the documentation tools and can be auto-generated at documentation build time.
Installation Installation
============ ------------
Python Python
------ ^^^^^^
The library can be installed with: The library can be installed with:
...@@ -24,4 +29,9 @@ If you desire to build teqp yourself, it is recommended to pull from github and ...@@ -24,4 +29,9 @@ If you desire to build teqp yourself, it is recommended to pull from github and
git clone --recursive https://github.com/usnistgov/teqp git clone --recursive https://github.com/usnistgov/teqp
cd teqp cd teqp
python setup.py bdist_wheel python setup.py bdist_wheel
pip install dist/*.whl # or replace with the appropriate binary wheel pip install dist/*.whl # or replace with the appropriate binary wheel
\ No newline at end of file
C++
^^^
The build is cmake based. There are targets available for an interface library, etc. Please see ``CMakeLists.txt``
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment