Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
SWIFTsim
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Model registry
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
SWIFT
SWIFTsim
Commits
040811b2
Commit
040811b2
authored
7 years ago
by
Josh Borrow
Browse files
Options
Downloads
Patches
Plain Diff
Removed claim about exascale (that one was a _bit_ much)
parent
9a9d09b4
Branches
Branches containing commit
Tags
Tags containing commit
1 merge request
!517
Added GitHub README
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+17
-14
17 additions, 14 deletions
README.md
with
17 additions
and
14 deletions
README.md
+
17
−
14
View file @
040811b2
...
...
@@ -5,8 +5,12 @@ For information on how to _run_ SWIFT, please consult the onboarding guide
available
[
here
](
http://www.swiftsim.com/onboarding.pdf
)
. This includes
dependencies, and a few examples to get you going.
SWIFT is an SPH code designed to run cosmological simulations on peta- and
exa-scale machines, scaling well up to 10's of thousands of cores.
We suggest that you use the latest release branch of SWIFT, rather than the
current master branch as this will change rapidly. We do, however, like to
ensure that the master branch will build and run.
SWIFT is an SPH code designed to run cosmological simulations on peta-scale
machines, scaling well up to 10's of thousands of cores.
More general information about SWIFT is available on the project
[
webpages
](
http://www.swiftsim.com
)
.
...
...
@@ -24,18 +28,17 @@ team is quite small this could take some time.
Contribution Guidelines
-----------------------
The SWIFT source code is using a variation of the 'Google' formatting style.
The script 'format.sh' in the root directory applies the clang-format-3.8
tool with our style choices to all the SWIFT C source file. Please apply
the formatting script to the files before submitting a merge request.
The SWIFT code comes with a series of unit tests that are run automatically
when a push to the master branch occurs. The suite can be run by doing a make
check in the root directory. Please check that the test suite still
runs with your changes applied before submitting a merge request and add
relevant unit tests probing the correctness of new modules. An example of how
to add a test to the suite can be found by considering the tests/testGreeting
case.
The SWIFT source code uses a variation of the 'Google' formatting style. The
script 'format.sh' in the root directory applies the clang-format-3.8 tool with
our style choices to all the SWIFT C source file. Please apply the formatting
script to the files before submitting a pull request.
Please check that the test suite still runs with your changes applied before
submitting a pull request and add relevant unit tests probing the correctness
of new modules. An example of how to add a test to the suite can be found by
considering the tests/testGreeting case.
Any contributions that fail any of the automated tests will not be accepted.
```
Welcome to the cosmological hydrodynamical code
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment