Skip to content

Commit 334e33b

Browse files
committed
adding download links for the example trajectory data
1 parent 70687c3 commit 334e33b

2 files changed

Lines changed: 33 additions & 8 deletions

File tree

docs/community_guide.rst

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ Community guidelines
33

44
Contribute to the software
55
-----------------------------
6-
To contribute to CodeEntropy, fork the repository and create a pull request when you want to share and push your changes upstream.
6+
To contribute to CodeEntropy, see the Developer's Information section below.
77

8-
Report Issue
8+
Report Issues
99
-----------------
1010
Create an issue ticket on GitHub and the team will review it as soon as possible. Please send us the input file as well.
1111

@@ -39,10 +39,13 @@ To only run the a specific test, e.g.:
3939
4040
pytest CodeEntropy/tests/test_CodeEntropy/test_levels.py::test_select_levels
4141
42-
Including your code into the CodeEntropy repository
43-
---------------------------------------------------
44-
In order to add to CodeEntropy, a pull request must be created.
42+
Including your code into the CodeEntropy repository
43+
---------------------------------------------------
44+
Any bugs, problems, or feature requests should get an issue on the GitHub repostitory that clearly explains the situation.
4545
Code cannot be committed directly to the main branch.
46+
New branches should be named after the issue that is being worked on.
4647

48+
In order to add code to the main branch of CodeEntropy, a pull request must be created.
4749
All pull requests will be reviewed by at least one of the core development team.
48-
50+
Up to date documentation and tests for all new code will be required before a pull request is approved.
51+
Please use the pull request template, clearly explaining the purpose and effect of the pull request will aid in reviewing them quickly and accurately.

docs/getting_started.rst

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,30 @@ Getting Started
44
Requirements
55
----------------
66

7-
* Python > 3.9
7+
* Python >= 3.11
88

99
Installation
1010
----------------
11-
Run the following at the root directory of this repository
11+
To install the released version:
1212

1313
.. code-block:: bash
1414
1515
pip install CodeEntropy
1616
17+
To install the latest development version:
18+
19+
.. code-block:: bash
20+
21+
git clone https://github.com/CCPBioSim/CodeEntropy.git
22+
23+
.. code-block:: bash
24+
25+
cd CodeEntropy
26+
27+
.. code-block:: bash
28+
29+
pip install .
30+
1731
Input
1832
----------
1933
For supported format (any topology and trajectory formats that can be read by `MDAnalysis <https://userguide.mdanalysis.org/stable/formats/index.html>`_) you will need to output the **coordinates** and **forces** to the **same file**.
@@ -148,3 +162,11 @@ Or as an alternative, you could edit the config.yaml file and use the CodeEntrop
148162

149163
CodeEntropy creates job* directories for the output, where * is a job number choosen by the so that there are sequentially numbered directories when you rerun CodeEntropy in the same working directory.
150164
Each job* directory contains the output json file and a subdirectory with the log files.
165+
166+
Data Files
167+
^^^^^^^^^^
168+
The example files mentioned above can be downloaded.
169+
170+
`Lysozyme example (~1.2GB) <https://ccpbiosim.ac.uk/file-store/codeentropy-examples/lysozyme_example.tar>`_
171+
172+
`DNA fragment example (~1MB) <https://ccpbiosim.ac.uk/file-store/codeentropy-examples/dna_example.tar>`_

0 commit comments

Comments
 (0)