Skip to content

Latest commit

 

History

History
57 lines (42 loc) · 3.95 KB

README.md

File metadata and controls

57 lines (42 loc) · 3.95 KB
Raw

Nek5000

Short Tests Examples
Build Build Status

Nek5000 is a fast and scalable open source CFD solver.

Release Notes

Make sure to read the release notes before using the code.

Documentation

Visit our User's Guide.

Troubleshooting

If you run into problems compiling, installing, or running Nek5000, first check the User's Guide. If you are not able to find a solution to your problem there, please send a message to the User's Group mailing list.

Reporting Bugs

Nek5000 is hosted on GitHub and all bugs are reported and tracked through the Issues feature on GitHub. However, GitHub Issues should not be used for common troubleshooting purposes. If you are having trouble installing the code or getting your model to run properly, you should first send a message to the User's Group mailing list. If it turns out your issue really is a bug in the code, an issue will then be created on GitHub. If you want to request that a feature be added to the code, you may create an Issue on GitHub.

Contributing

Our project is hosted on GitHub. If you are planning a large contribution, we encourage you to discuss the concept here on GitHub and interact with us frequently to ensure that your effort is well-directed.

How we do it

  • Anything in master is always deployable
  • Upcoming feature release get their own tags or branch that are branched out of master
  • All development happens on the master branch.
  • To work on something new, create a short lived local branch off of master
  • When you need feedback or help, or your change is ready for merging, open a pull request.

One-time Setup

  1. Fork our GitHub project
  2. Download fork with git clone -o myfork https://github.com/<username>/Nek5000.git ~/Nek5000
  3. Add our repo cd ~/Nek5000; git remote add origin https://github.com/Nek5000/Nek5000.git
  4. Download our repo git fetch origin
  5. Set upstream for local master branch git branch --set-upstream master remotes/origin/master
  6. Run ~/Nek5000/bin/git-hub setup —u <your username on GitHub> --global
  7. Add this to your [hub] section in ~/.gitconfig:
[hub]
        ...
        upstream = Nek5000/Nek5000
        forkremote = myfork

Typical Workflow

  1. Create a feature branch hosting your change with nekgit_co <descriptive name>. Using a dedicated branch for every feature helps you to move between different developments while some are work in progress or under review.
  2. Implement your code changes. To reset your branch and discard any changes run git reset --hard origin/master. To revert a set of files run git checkout file1 file2 ...
  3. Commit your changes to your local repo using e.g. git commit file1 file2 .... Do this frequently to save your work.
  4. Periodically, changes made in our master should be pulled back into your local branch by git pull -r. This ensures that we do not end up in integration hell that will happen when many feature branches need to be combined at once.
  5. If there are no merge conflicts, go to the next step. In case of conflicts edit the unmerged files in question. Merge conflicts are indicated by the conflict marker <<<<<<< in your file.
  6. Assuming you are happy run nekgit_push. This will create a pull request on GitHub. You can check with git diff origin/master what your push will do. When your pull request was merged, run git pull on your local master branch to see your change. You can delete the branch created in step (1) with nekgit_rm <my branch name>.