diff --git a/doc/source/getting_started/index.rst b/doc/source/getting_started/index.rst index b8a43f6193bc4123be91d1a165ea1ff81f3b425b..17d2e03c3fed417a593d5a11b37fad7a3c7786e4 100644 --- a/doc/source/getting_started/index.rst +++ b/doc/source/getting_started/index.rst @@ -1,13 +1,18 @@ +Getting Started +=============== + 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 -============ +------------ Python ------- +^^^^^^ 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 git clone --recursive https://github.com/usnistgov/teqp cd teqp python setup.py bdist_wheel - pip install dist/*.whl # or replace with the appropriate binary wheel \ No newline at end of file + pip install dist/*.whl # or replace with the appropriate binary wheel + +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