Skip to content

Commit

Permalink
Merge branch 'hotfix/4.17.14' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
keithbennett committed Feb 4, 2021
2 parents 60192c6 + 4295b70 commit 3245264
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 16 deletions.
2 changes: 1 addition & 1 deletion .gitmodules
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[submodule "SDF"]
path = SDF
url = https://cfsa-pmw.warwick.ac.uk/SDF/SDF.git
url = ../SDF.git
8 changes: 3 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ of answers between minor versions, and strict backwards compatibility.

EPOCH development and maintenance
is ongoing, so please search for open issues at
https://cfsa-pmw.warwick.ac.uk/EPOCH/epoch/issues
https://github.com/Warwick-Plasma/epoch/issues
and consider creating an issue
with the enhancement tag before starting anything to avoid
duplication of effort. The development team is quite busy, so please allow
Expand Down Expand Up @@ -44,7 +44,7 @@ terms as the rest of the code (GPL v3).
For developer access to the main EPOCH repositories, please contact
<cfsa.gitlab+admin@gmail.com>.
For small fixes patches can be offered via the issue tracker which can
be found at https://cfsa-pmw.warwick.ac.uk/EPOCH/epoch/issues
be found at https://github.com/Warwick-Plasma/epoch/issues


# Coding Style
Expand Down Expand Up @@ -75,9 +75,7 @@ in the main code. Conditional compilation (#ifdef) should be used
Where possible, all control should be via the input deck. Backwards
compatibility must be preserved.

Documentation will be required, either in Latex format or a page on our
Mediawiki site currently at
https://cfsa-pmw.warwick.ac.uk/mediawiki/index.php/EPOCH:Landing_Page.
Documentation will be required in Latex format.
This should cover any changes to the input deck blocks or keys, any general
limitations of the code or methods and if possible links to any methods
papers or description.
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,31 @@
# *** PLEASE READ THIS NOTE ***

If you are obtaining this code from the gitlab server *DO NOT* use the
If you are obtaining this code from the github server *DO NOT* use the
"Download zip" buttons. They will only download the EPOCH code and not the SDF
subdirectory.

The latest version of the code can be found
[here](https://cfsa-pmw.warwick.ac.uk/EPOCH/epoch/wikis/Downloads)
[here](https://github.com/Warwick-Plasma/epoch/releases)

For similar reasons, if cloning the repository using git you *MUST* add the
"--recursive" flag.

## DOWNLOADING AND BUILDING THE CODE

The easiest method of downloading the code is to grab a copy of the latest
release package, located in the "Downloads" wiki page on the GitLab site.
To get there, click the "Wiki" link on the left-hand side of the EPOCH/epoch
project page and then follow the "Downloads" link. You can also get there by
following
[this link](https://cfsa-pmw.warwick.ac.uk/EPOCH/epoch/wikis/Downloads).
release package, located in the "Releases" section of the GitHub site.
You can get there by following
[this link](https://github.com/Warwick-Plasma/epoch/releases)

All EPOCH development is carried out using the [git](https://git-scm.com)
revision control system. The master repository is hosted on a web-based
collaborative development site
[here](https://cfsa-pmw.warwick.ac.uk/EPOCH/epoch).
[here](https://github.com/Warwick-Plasma/epoch)
Further details on this are provided below.

## Compiling the code

The "Downloads" section of the GitLab site contains files in the form
The "Releases" section of the GitHub site contains files in the form
"epoch-4.4.5.tar.gz". These are tarred and gzipped packages of the code
which can be unpacked with the command `tar xzf epoch-4.4.5.tar.gz`.
This will create a directory called "epoch-4.4.5".
Expand Down Expand Up @@ -157,7 +155,7 @@ To perform an initial checkout of the code using git, you should issue the
following command:

```
git clone --recursive git@cfsa-pmw.warwick.ac.uk:EPOCH/epoch.git
git clone --recursive https://github.com/Warwick-Plasma/epoch.git
```

The "--recursive" flag ensures that not only the "epoch"
Expand Down

0 comments on commit 3245264

Please sign in to comment.