Skip to content

Latest commit

 

History

History
49 lines (38 loc) · 4.71 KB

README.md

File metadata and controls

49 lines (38 loc) · 4.71 KB

Docs Chat Cite Status
docs docs gitter DOI Build Status codecov

Omniscape.jl is built on Circuitscape.jl and implements the Omniscape connectivity modeling algorithm to map omni-directional habitat connectivity. The Omniscape algorithm was developed by McRae and colleagues in 2016. Check out the docs for additional information.

Installation Omniscape Downloads

The latest version of Omniscape.jl requires Julia version 1.9 or greater. You can install Julia here. Once installation is complete, open a Julia terminal and run the following code to install Omniscape.jl.

using Pkg; Pkg.add("Omniscape")

If you want to install the latest (unreleased) development version of Omniscape, you can get it by running:

using Pkg; Pkg.add(PackageSpec(name = "Omniscape", rev = "main"))

Citing Omniscape.jl

Please cite Landau et al. (2021) when using Omniscape.jl.

Landau, V.A., V.B. Shah, R. Anantharaman, and K.R. Hall. 2021. Omniscape.jl: Software to compute omnidirectional landscape connectivity. Journal of Open Source Software, 6(57), 2829.

Here's a bibtex entry:

@article{Landau2021,
  doi = {10.21105/joss.02829},
  url = {https://doi.org/10.21105/joss.02829},
  year = {2021},
  publisher = {The Open Journal},
  volume = {6},
  number = {57},
  pages = {2829},
  author = {Vincent A. Landau and Viral B. Shah and Ranjan Anantharaman and Kimberly R. Hall},
  title = {Omniscape.jl: Software to compute omnidirectional landscape connectivity},
  journal = {Journal of Open Source Software}
}

Please be sure to also cite the original work where the Omniscape algorithm was first described:

McRae, B. H., K. Popper, A. Jones, M. Schindel, S. Buttrick, K. R. Hall, R. S. Unnasch, and J. Platt. 2016. Conserving Nature’s Stage: Mapping Omnidirectional Connectivity for Resilient Terrestrial Landscapes in the Pacific Northwest. The Nature Conservancy, Portland, Oregon.

Contributing

Contributions in the form of pull requests are always welcome and appreciated. To report a bug or make a feature request, please file an issue. For general discussions and questions about usage, start a conversation on gitter.

Acknowledgments

Development of this software package was made possible by funding from NASA's Ecological Forecasting program and the Wilburforce Foundation through a project led by Kim Hall at The Nature Conservancy. This software package would not have been possible without Brad McRae (1966-2017), the visionary behind Circuitscape, the Omniscape algorithm, and several other software tools for assessing connectivity. Omniscape.jl is built on Circuitscape.jl, which was authored by Ranjan Anantharaman and Viral Shah, both of whom have been incredibly helpful in steering and guiding the development of Omniscape.jl. Kim Hall, Aaron Jones, Carrie Schloss, Melissa Clark, Jim Platt, and early Omniscape.jl users helped steer software development by providing valuable feedback and insight.