Skip to content

Commit e5810dd

Browse files
authored
Merge pull request #208 from bartnijssen/master
Merge develop into master for Version 2.0
2 parents a7e3f14 + c6ea355 commit e5810dd

File tree

104 files changed

+21990
-11591
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

104 files changed

+21990
-11591
lines changed

.github.com/CONTRIBUTING.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Contributing
2+
3+
SUMMA is Open Source software. This means that the code is made available for free, but also that development, maintenance and support are intended to be community efforts. Our rationale for moving SUMMA model development to an open source model is that we want:
4+
5+
- to encourage other researchers and developers to contribute to SUMMA development, and
6+
- to facilitate transparent development and use of the model.
7+
8+
## Support
9+
10+
There is no official support for the SUMMA model, other than the SUMMA documentation, the SUMMA source code archive and the description of the model in the literature. Any additional support relies on volunteer efforts by the SUMMA development community. The following resources are available:
11+
12+
- [SUMMA web site](https://www.ral.ucar.edu/projects/summa): General background, SUMMA resources, and test data sets.
13+
- [SUMMA Source code repository](https://github.com/NCAR/SUMMA) : Source code distribution, coordination of model development, bug fixes, and releases.
14+
15+
We expect that the user comes prepared with some understanding of the model and scientific computing. As such, these items are specifically not supported by the SUMMA development community:
16+
17+
- Building and running the SUMMA model on platforms other than LINUX, UNIX, and OSX.
18+
- Using LINUX, UNIX, or OSX operating systems.
19+
- Development of project specific features.
20+
- Configuring individual model applications.
21+
22+
## Submitting Issues
23+
#### Submitting Bug Reports
24+
25+
If you think you have found a bug in SUMMA, please check whether an issue has been filed on [SUMMA's Github page](https://github.com/NCAR/SUMMA/issues). If not, go please go ahead and create an issue and include the following information in your bug report:
26+
27+
- Version of SUMMA that you are using (e.g. SUMMA 1.0 - even better if you can provide the specific tag or commit)
28+
- Name and version of the fortran compiler you are using
29+
- Operating system
30+
- A description of relevant model settings
31+
- A summary of the bug or error message you are getting
32+
33+
If you can provide more information that is great. If you know how to run the model in a debugger, you may be able to pinpoint where the problem occurs.
34+
35+
#### Proposing New Features
36+
37+
SUMMA is under active development. If you would like to propose a new feature, driver, or extension to SUMMA, please file an issue on [SUMMA's Github page](https://github.com/NCAR/SUMMA/issues). Also, because SUMMA is an open source model with no official support for general-purpose development, be prepared to contribute to the implementation of your feature request. Features that are only of interest to you are unlikely to be implemented in the main source code repo (although you are of course free to modify the code in any way you see fit).
38+
39+
## Contributing to SUMMA
40+
#### Git Workflow
41+
We have developed some documentation to help you get started if you are new to Git but want to contribute to VIC:
42+
43+
- [Working with Git](https://github.com/NCAR/summa/blob/master/docs/howto/git_howto.md)
44+
- [Git Workflow](https://github.com/NCAR/summa/blob/master/docs/howto/summa_git_workflow.md)
45+
46+
#### Coding Conventions
47+
We have some simple [https://github.com/NCAR/summa/blob/master/docs/howto/summa_coding_conventions.md](coding conventions) that we would like anyone who contributes code to SUMMA to follow.

.github.com/ISSUE_TEMPLATE.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
#### Bug Reports
2+
<!--- please provide the following information for bug reports --->
3+
4+
- Version of SUMMA that you are using (e.g. SUMMA 1.0 - even better if you can provide the specific tag or commit)
5+
- Name and version of the fortran compiler you are using
6+
- Operating system
7+
- A description of relevant model settings
8+
- A summary of the bug or error message you are getting
9+
10+
#### Feature Requests
11+
<!--- please provide the following information for feature requests --->
12+
13+
- Description of feature
14+
- Description of the problem the feature addresses
15+
- Will the proposed feature be backward compatible?
16+
- Will the proposed feature change the science results of SUMMA?
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Make sure all the relevant boxes are checked (and only check the box if you actually completed the step):
2+
3+
- [ ] closes #xxx (identify the issue associated with this PR)
4+
- [ ] tests passed
5+
- [ ] new tests added
6+
- [ ] science test figures
7+
- [ ] checked that the new code conforms to the [SUMMA coding conventions](https://github.com/NCAR/summa/blob/master/docs/howto/summa_coding_conventions.md)
8+
- [ ] ReleaseNotes entry

.gitignore

100644100755
Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,16 @@ summa.exe
1919
*cscope*
2020
.tags*
2121
# OS X .DS_Store files
22-
.DS_Store
22+
.DS_Store
23+
*-local
24+
*_local
25+
*log
26+
*.cbp
27+
*.layout
28+
gmon.out
29+
summa.exe.dSYM*
30+
# makefile
31+
make.out
32+
Makefile-*
33+
# backup files
34+
*.backup

.travis.yml

100644100755
File mode changed.

COPYING

100644100755
File mode changed.

Dockerfile

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# use the zesty distribution, which has gcc-6
2+
FROM ubuntu:zesty
3+
4+
# install only the packages that are needed
5+
RUN apt-get update && \
6+
apt-get install -y --no-install-recommends \
7+
git \
8+
make \
9+
gfortran-6 \
10+
libnetcdff-dev \
11+
liblapack-dev \
12+
&& apt-get clean
13+
14+
# set environment variables for docker build
15+
ENV F_MASTER /code
16+
ENV FC gfortran
17+
ENV FC_EXE gfortran
18+
ENV FC_ENV gfortran-6-docker
19+
20+
# add code directory
21+
WORKDIR /code
22+
ADD . /code
23+
24+
# build summa
25+
RUN make -C build/ -f Makefile
26+
27+
# run summa when running the docker image
28+
WORKDIR bin
29+
ENTRYPOINT ["./summa.exe"]

0 commit comments

Comments
 (0)