Skip to content

Commit

Permalink
Merge pull request #39 from harmsm/master
Browse files Browse the repository at this point in the history
few changes to docs
  • Loading branch information
harmsm committed Apr 25, 2017
2 parents c7ab46f + bcf7545 commit 481b801
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 28 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 0 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,6 @@ Features
+ Easy integration with `jupyter <https://jupyter.org/>`_ notebooks for
writing custom fitting scripts.

Try it out!
===========

We have posted a `jupyter <https://jupyter.org/>`_ notebook demonstrating the
capabilities of the API on `binder <http://mybinder.org:/repo/harmslab/pytc-binder>`_.

.. image:: http://mybinder.org/badge.svg :target: http://mybinder.org:/repo/harmslab/pytc-binder


API Quick Start
===============

Expand Down
4 changes: 2 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
21 changes: 7 additions & 14 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,22 +30,13 @@ Features
+ Easy integration with `jupyter <https://jupyter.org/>`_ notebooks for
writing custom fitting scripts.

Try it out!
===========

We have posted a `jupyter <https://jupyter.org/>`_ notebook demonstrating the
capabilities of the API on `binder <http://mybinder.org:/repo/harmslab/pytc-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
Expand Down Expand Up @@ -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 <https://pytc-gui.readthedocs.io/en/latest/>`_.

.. image:: images/gui_01.png
.. image:: images/gui_02.png
Expand All @@ -90,8 +83,8 @@ Documentation
=============

+ `Installation <installation.html>`_
+ `Fitting models using the script API <http://mybinder.org:/repo/harmslab/pytc-binder>`_.
+ `Fitting models using the GUI API <https://pytc-gui.readthedocs.io/en/latest/>`_.
+ Fitting models using the script API `see demos/Demo.ipynb. <https://github.com/harmslab/pytc/blob/master/demos/Demo.ipynb>`_.
+ `Fitting models using the GUI <https://pytc-gui.readthedocs.io/en/latest/>`_.
+ `Fitting and statistics <statistics.html>`_.
+ `Description of individual experiment models included in package <indiv_models.html>`_.
+ `Description of global fits included in package <global_models.html>`_.
Expand Down

0 comments on commit 481b801

Please sign in to comment.