Merge pull request #67 from T-Nicholls/docChanges

Update documentation

docs/developers.rst

@@ -0,0 +1,42 @@
+Developers
+==========
+
+The installation and initialiseation steps are slightly different if you want to work on pytac.
+
+
+Installation
+~~~~~~~~~~~~
+
+This is only required on your first use.
+
+- Ensure you have the following requirements: Pip, Pipenv, and a local copy of pytac.
+
+- Install dev-packages and cothread for EPICS support::
+
+    $ pipenv install --dev
+    $ pip install cothread	#cothread is required for EPICS funtionality, but pytac can run without it.
+
+
+Initialisation
+~~~~~~~~~~~~~~
+
+This is required each time you want to start up pytac.
+
+- Navigate to your pytac directory and activate a Pipenv shell, and start Python::
+
+    $ cd <directory-path>
+    $ pipenv shell
+    $ python
+    Python 2.7.3 (default, Nov  9 2013, 21:59:00)
+    [GCC 4.4.7 20120313 (Red Hat 4.4.7-3)] on linux2
+    Type "help", "copyright", "credits" or "license" for more information.
+    >>>
+
+
+- Import pytac and initialise the ``VMX`` ring mode::
+
+    >>> import pytac.load_csv
+    >>> lattice = pytac.load_csv.load('VMX')
+
+
+The ``lattice`` object is used for interacting with elements of the accelerator.

docs/examples.rst

@@ -1,4 +1,3 @@
-========
 Examples
 ========
 
@@ -7,24 +6,20 @@ Installation
 
 This is only required on your first use.
 
-- Ensure you have the following requirements: Pip, Pipenv, and a local copy of pytac.
-
-- Install dev-packages, pytac, and cothread for EPICS support::
+- Ensure you have Pip, then install pytac and cothread::
 
-    $ pipenv install --dev
     $ pip install pytac
-    $ pip install cothread
+    $ pip install cothread	#cothread is required for EPICS funtionality, but pytac can run without it.
 
 
 Initialisation
 ~~~~~~~~~~~~~~
 
 This is required each time you want to start up pytac.
 
-- Navigate to your pytac directory and activate a Pipenv shell, and start Python::
+- Navigate to your pytac directory and start Python::
 
     $ cd <directory-path>
-    $ pipenv shell
     $ python
     Python 2.7.3 (default, Nov  9 2013, 21:59:00)
     [GCC 4.4.7 20120313 (Red Hat 4.4.7-3)] on linux2

docs/index.rst

@@ -33,6 +33,7 @@ Contents:
 
    self
    examples
+   developers
    pytac