Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update documentation #67

Merged
merged 6 commits into from
Aug 1, 2018
Merged

Update documentation #67

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7781e14
Comment on cothread about EPICS and remove redundant text.
T-Nicholls Jul 11, 2018
1844775
Remove unnecessary heading syntax above 'Examples'.
T-Nicholls Jul 11, 2018
bbe08af
Remove developer specific material from first two sections.
T-Nicholls Jul 11, 2018
7df5636
Create developers.rst and add installation and initialisation sections.
T-Nicholls Jul 11, 2018
b87150f
Add developers page to contents list.
T-Nicholls Jul 11, 2018
2fc1b46
Implement corrections to wording of installation sections.
T-Nicholls Jul 26, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions docs/developers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
11 changes: 3 additions & 8 deletions docs/examples.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
========
Examples
========

Expand All @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Contents:

self
examples
developers
pytac


Expand Down