diff --git a/README.md b/README.md index 5a2ef85..d80e463 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,11 @@ A python software package for analyzing Isothermal Titration Calorimetry experiments. - + [Documentation](https://pytc.readthedocs.io/en/latest/) + + [Full documentation](https://pytc.readthedocs.io/en/latest/) + [Graphical User Interface](https://github.com/harmslab/pytc-gui) - + Try it out: [![Binder](http://mybinder.org/badge.svg)](http://mybinder.org:/repo/harmslab/pytc-binder) ## Quick Start - + Install via pip `sudo python3 install pytc-fitter` (Mac/Linux), `python3 -m pip install pytc-fitter` (Windows) + + Install via pip `sudo pip3 install pytc-fitter` (Mac/Linux), `python3 -m pip install pytc-fitter` (Windows) + Alternatively, clone from github and install ``` git clone https://github.com/harmslab/pytc.git diff --git a/README.rst b/README.rst index 7706e3e..a0617fb 100644 --- a/README.rst +++ b/README.rst @@ -32,15 +32,6 @@ Features + Easy integration with `jupyter `_ notebooks for writing custom fitting scripts. -Try it out! -=========== - -We have posted a `jupyter `_ notebook demonstrating the -capabilities of the API on `binder `_. - -.. image:: http://mybinder.org/badge.svg :target: http://mybinder.org:/repo/harmslab/pytc-binder - - API Quick Start =============== diff --git a/docs/source/conf.py b/docs/source/conf.py index a41bb22..ab64347 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -59,9 +59,9 @@ # built documents. # # The short X.Y version. -version = '0.1' +version = '1.0' # The full version, including alpha/beta/rc tags. -release = '0.1' +release = '1.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/source/index.rst b/docs/source/index.rst index 7a114ae..85224d1 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -30,22 +30,13 @@ Features + Easy integration with `jupyter `_ notebooks for writing custom fitting scripts. -Try it out! -=========== - -We have posted a `jupyter `_ notebook demonstrating the -capabilities of the API on `binder `_. - -.. image:: http://mybinder.org/badge.svg :target: http://mybinder.org:/repo/harmslab/pytc-binder - - API Quick Start =============== If you already have a python3-based scientific computing environment installed, you can start using the API by: -.. sourcecode :: +.. sourcecode:: bash # Install pytc sudo pip3 install pytc-fitter @@ -80,8 +71,10 @@ Fit a :math:`Ca^{2+}/EDTA` binding experiment to a single-site binding model. g.plot() print(g.fit_as_csv) -GUI Screen shots -================ +GUI +=== + +`GUI docs `_. .. image:: images/gui_01.png .. image:: images/gui_02.png @@ -90,8 +83,8 @@ Documentation ============= + `Installation `_ - + `Fitting models using the script API `_. - + `Fitting models using the GUI API `_. + + Fitting models using the script API `see demos/Demo.ipynb. `_. + + `Fitting models using the GUI `_. + `Fitting and statistics `_. + `Description of individual experiment models included in package `_. + `Description of global fits included in package `_.