You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
VIC is Open Source software. Our rationale for moving the VIC model development to the open source community is that we want:
3
+
VIC is Open Source software. This means that the code is made available for free, but also that development, maintenance and support need to be community efforts. Our rationale for moving the VIC model development to the open source community is that we want:
4
4
5
-
- to encourage other researchers and developers to contribute to the VIC development, and
5
+
- to encourage other researchers and developers to contribute to VIC development, and
6
6
- to facilitate transparent development and use of the model.
7
7
8
-
## Official Support
8
+
## Support
9
9
10
-
The VIC development community assumes the role of a limited scope of official support.
10
+
There is no official support for the VIC model, other than the VIC documentation, the VIC source code archive and the description of the model in the literature. Any additional support relies on volunteer efforts by the VIC development community, which means that no one is being paid to provide VIC support. The following resources are available:
11
11
12
-
-Coordination of model development, bug fixes, and releases.
13
-
-Distribution of model [documentation](http://vic.readthedocs.org)and [source code](https://github.com/UW-Hydro/VIC).
12
+
-[VIC Source code repository](https://github.com/UW-Hydro/VIC) : Source code distribution, coordination of model development, bug fixes, and releases.
Due to limited resources, there is not official support for some of the tasks related to using VIC. We expected that the user comes prepared with some understanding of the model and scientific computing. As such, these items are specifically not supported by the VIC development community:
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 VIC development community:
18
16
19
17
- Building and running the VIC model on platforms other than LINUX, UNIX, and OSX.
20
18
- Using LINUX, UNIX, or OSX operating systems.
@@ -25,7 +23,7 @@ Due to limited resources, there is not official support for some of the tasks re
25
23
26
24
The VIC user and developer community is quite large and is spread all around the world. Depending on the question or issue your facing, there are a number of avenues to get in-touch:
Developers Gitter Room: [](https://gitter.im/UW-Hydro/VIC?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
31
29
@@ -38,19 +36,22 @@ If you think you have found a bug in VIC, please file an issue on Github [here](
38
36
39
37
- Version of VIC that you are using (e.g. VIC.4.2.b)
40
38
- Name and version of the C compiler you are using
39
+
- Operating system
41
40
- A description of relevant model settings
42
41
- A summary of the bug or error message you are getting
43
42
43
+
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.
44
+
44
45
#### Requesting New features
45
46
46
-
The VIC model is under active development. If you would like to propose a new feature, driver, or extension to the VIC model, please raise a Github issue [here](https://github.com/UW-Hydro/VIC/issues). Also, because VIC is an open source model with little official support, please also be prepared to contribute to the implementation of your feature request.
47
+
The VIC model is under active development. If you would like to propose a new feature, driver, or extension to the VIC model, please raise a Github issue [here](https://github.com/UW-Hydro/VIC/issues). Also, because VIC is an open source model with no official support for development, be prepared to contribute to the implementation of your feature request. Also note that 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).
47
48
48
49
## Contributing to VIC
49
50
#### Git Workflow
50
-
New to Git but want to contribute to VIC, we have developed some documentation to help you get started:
51
+
We have developed some documentation to help you get started if you are new to Git but want to contribute to VIC:
51
52
52
53
-[Working with Git](http://vic.readthedocs.org/en/latest/Development/working-with-git/)
To be added soon. For now, please remember to comment your code well and [use `uncrustify` to format your code properly](https://github.com/UW-Hydro/VIC/tree/master/tools/code_format).
57
+
To be added soon. For now, please remember to comment your code well and [use `uncrustify` to format your code properly](https://github.com/UW-Hydro/VIC/tree/master/tools/code_format).
0 commit comments