Skip to content

Repository files navigation

is-sea

Travis CI Codecov npm npm version npm dependencies npm dev dependencies DOI

🌊 Check whether a geographic coordinate is in the sea or not on the earth.

Click on the map to see a live preview.

Synopsis

Given the latitude and longitude coordinates this package returns whether the point fall into a sea/ocean or not.

The package internally uses @geo-maps/earth-seas map with 10m resolution. The accuracy of the map has not been tested but the demo allows you to actually test it manually by just clicking on the map to see what it returns.

Do you believe that this is useful? If so, support us with a ⭐️!

Install

$ npm install --save is-sea

Usage

You can query any (lat,lng) pair on the earth.

const isSea = require('is-sea');

// Query a point in Italy.
isSea.get(41.9028, 12.4964);
// => false

// Query a point somewhere in Atlantic Ocean.
isSea.get(40, -40);
// => true

API

get(lat, lng) β‡’ Array.<string>

Returns wheather the given point is in the sea or not.

Returns: Array.<string> - True if the point is in the sea, false otherwise.

Param Type Description
lat number The latitude of the point.
lng number The longitude of the point.

Related

  • country-iso: πŸ—Ί Get ISO 3166-1 alpha-3 country code from geographic coordinates.

Citation

If you use is-sea in your research, please cite it using the metadata in CITATION.cff, or the following BibTeX entry:

@software{primarosa_is_sea,
  author    = {Primarosa, Simone},
  title     = {{is-sea}: Check whether a geographic coordinate is in the sea or not on the earth},
  year      = {2017},
  publisher = {Zenodo},
  doi       = {10.5281/zenodo.20585085},
  url       = {https://github.com/simonepri/is-sea}
}

The concept DOI 10.5281/zenodo.20585085 always resolves to the latest release.

Used in research

is-sea has been used to curate geographic sample metadata in the following peer-reviewed publications:

  • CorrΓͺa, F. B., Saraiva, J. P., Stadler, P. F., & Nunes da Rocha, U. (2020). TerrestrialMetagenomeDB: a public repository of curated and standardized metadata for terrestrial metagenomes. Nucleic Acids Research, 48(D1), D626–D632. https://doi.org/10.1093/nar/gkz994
  • Nata'ala, M. K., Avila Santos, A. P., Coelho Kasmanas, J., et al. (2022). MarineMetagenomeDB: a public repository for curated and standardized metadata for marine metagenomes. Environmental Microbiome, 17, 57. https://doi.org/10.1186/s40793-022-00449-7

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

🌊 Check whether a geographic coordinate is in the sea or not on the earth.

Topics

Resources

Code of conduct

Stars

53 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages