Installation

The lgrs library is available on PyPI, and can be pip-installed:

$> pip install lgrs

Alternately, you can clone or download this repository.

It is highly suggested to install this into a virtual Python environment.

Change directory to where you have downloaded this repository after you have set up your virtual environment, just do this:

$> pip install .

or:

$> make install

If you use conda for your virtual environment and install dependencies via conda, you can do this:

$> conda create -n lgrs
$> conda activate lgrs
$> conda env update --file environment.yml
$> pip install --no-deps .

Usage

Examples and how to get started with the lgrs library can be found in our usage guide.

To use lgrs in a web browser (via Pyodide), see the JavaScript usage guide. The examples folder has two complete web pages that do so: convert_coordinate.html converts a coordinate, and package_grid.html generates and downloads a grid. To try one, download the file and open it in a web browser.

Contributing

Feedback, issues, and contributions are always gratefully welcomed. See the contributing guide for details on how to help and setup a development environment.

Credits

The lgrs library was developed in the open at the SETI Institute, based on open code originally developed by the United States Geological Survey.

See the AUTHORS file for a complete list of developers.

License

The lgrs software is licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.