From fd06b796f98a52ea15822b738491729d6ee3529c Mon Sep 17 00:00:00 2001 From: Ian Bell <ian.bell@nist.gov> Date: Wed, 6 Jul 2022 20:39:45 -0400 Subject: [PATCH] Reformat getting started --- doc/source/getting_started/index.rst | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/doc/source/getting_started/index.rst b/doc/source/getting_started/index.rst index b8a43f6..17d2e03 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 -- GitLab