mvdh7/co2system.jl

Julia port of CO2SYS software for MATLAB to compute variables of ocean CO2 system

Hi there 👋

I am a marine carbonate chemist at NIOZ Royal Netherlands Institute for Sea Research, Texel.

co2system.jl's Issues

How to cite CO2System.jl

I'm trying to cite this tool in a peer-reviewed publication and wonder if you could help me create a citation for this Julia version of the CO2SYS, i.e., CO2System.jl?

Below is the citation info for this tool according to this Github page. Unfortunately, none of them are specific to the CO2System.jl. Are there any plans to min a citation using Zenodo?

CITATION

If you use any CO2SYS related software, please cite the original work by Lewis and Wallace (1998).
If you use CO2SYS.m, please cite van Heuven et al (2011).
If you use errors.m or derivnum.m, please cite Orr et al. (2018).

[Suggestion] "Scalarize" the main function

Following jamesorr/CO2SYS-MATLAB#2, here is copy-pasted suggestion:

I wanted to suggest converting the main function, which takes scalars or arrays as input, into a function that takes only scalars as inputs. I think a scalar function, called e.g., co2sys(args...), would have many advantages over the current version (in Julia). Note that a scalar function would be easy to broadcast to arrays with Julia's dot syntax, e.g., for a simple example:

julia> f(x,y) = x + y # define the function on scalars
f (generic function with 1 method)

julia> f.([1, 2, 3], 4) # easily broadcast to those inputs that are arrays
3-element Vector{Int64}:
 5
 6
 7

Another potential gain is that the code would be simpler (e.g., less lines of code because no need for all the array treatment, the allocations, and so on). Furthermore, it might be computationally more efficient because, e.g., no need to reallocate the boolean indices array F dozens of times. (Although efficiency would need to be benchmarked against the current vectorized version I guess.)