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
Copy file name to clipboardExpand all lines: README.md
+30-3Lines changed: 30 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,10 +37,12 @@ For more details refer to the [documentation](https://fourierflows.github.io/Fou
37
37
38
38
## Installation
39
39
40
-
To install, simply do
40
+
To install, use Julia's built-in package manager to add the package and also to instantiate/build all the required dependencies
41
41
42
42
```julia
43
-
] add FourierFlows
43
+
julia>using Pkg
44
+
julia> Pkg.add("FourierFlows")
45
+
julia> Pkg.instantiate()
44
46
```
45
47
46
48
The most recent version of FourierFlows.jl requires Julia v1.5 or later.
@@ -81,19 +83,44 @@ See also the child packages [GeophysicalFlows.jl][] for example usage of Fourier
81
83
problems in Geophysical Fluid Dynamics.
82
84
83
85
86
+
## Getting help
87
+
88
+
Interested in using FourierFlows.jl or trying to figure out how to use it? Please feel free
89
+
to ask us questions and get in touch! The [documentation](https://fourierflows.github.io/FourierFlowsDocumentation/stable)
90
+
is always the best place to start. Check out the [examples](https://github.com/FourierFlows/FourierFlows.jl/tree/master/examples) and [open an issue](https://github.com/FourierFlows/FourierFlows.jl/issues/new)
91
+
or [start a discussion](https://github.com/FourierFlows/FourierFlows.jl/discussions/new)
92
+
if you have any questions, comments, suggestions, etc.
93
+
94
+
84
95
## Developers
85
96
86
97
FourierFlows is currently being developed by [Gregory L. Wagner][] (@glwagner)
87
98
and [Navid C. Constantinou][] (@navidcy).
88
99
89
100
90
-
## Cite
101
+
## Citing
91
102
92
103
The code is citable via [zenodo](https://zenodo.org). Please cite as:
93
104
94
105
> Navid C. Constantinou & Gregory L. Wagner. (2021). FourierFlows/FourierFlows.jl: FourierFlows v0.6.17 (Version v0.6.17). Zenodo. [http://doi.org/10.5281/zenodo.1161724](http://doi.org/10.5281/zenodo.1161724)
95
106
96
107
108
+
109
+
## Contributing
110
+
111
+
We are excited to get more people involved in contributing to the development of FourierFlows.jl!
112
+
We welcome any contribution, no matter how big or small! It's always great to have new people
113
+
look at the code with fresh eyes: you will see errors that other developers have missed.
114
+
115
+
Let us know by [open an issue](https://github.com/FourierFlows/FourierFlows.jl/issues/new)
116
+
or [start a discussion](https://github.com/FourierFlows/FourierFlows.jl/discussions/new)
117
+
if you'd like to work on a new feature or implement a new module, if you're new to open-source
118
+
and want to find a cool little project or issue to work on that fits your interests! We're more
119
+
than happy to help along the way.
120
+
121
+
For more information, check out our [contributor's guide](https://github.com/FourierFlows/FourierFlows.jl/blob/master/CONTRIBUTING.md).
122
+
123
+
97
124
[Julia]: https://julialang.org/
98
125
[Navid C. Constantinou]: http://www.navidconstantinou.com
0 commit comments