Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/nasa-ammos/mgviz

Multi-Mission Geographic Information System (MMGIS) Global Navigation Satellite System (GNSS) Visualizer
https://github.com/nasa-ammos/mgviz

Last synced: 4 months ago
JSON representation

Multi-Mission Geographic Information System (MMGIS) Global Navigation Satellite System (GNSS) Visualizer

Awesome Lists containing this project

README 

          
# MGViz - MMGIS GNSS Visualizer



**This is a fork of [MMGIS](https://github.com/NASA-AMMOS/MMGIS) (Multi-Mission Geographic Information System)

developed for the NASA MEaSUREs project “Extended Solid Earth Science ESDR System” (ESESES)**



**Project specific documentation and setup can be found here: [Missions/MGViz/README.md](Missions/MGViz/README.md)**







  


      MMGIS (Multi-Mission Geographic Information System)

  





Spatial Data Infrastructure for Planetary Missions



![Example](/docs/assets/images/Full_Example.png)



[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.15237385.svg)](https://doi.org/10.5281/zenodo.15237385)



---



## Features



- Web-based mapping interface

- 2D slippy map

- 3D globe with tiled height data

- Image viewer capable of showing mosaics with targets

- 5 fully customizable layer types

- Easy to use CMS

- Multi-user vector drawing

- Elevation profiler

- Custom projections

- Tiling scripts

- COGs

- TiTiler

- STAC

- And so much more...



---



## [Full documentation](https://nasa-ammos.github.io/MMGIS/)



---



## Installation



---



## Installing with Docker



`/` will always refer to the repo's root directory



1. Clone the repo  

   `git clone https://github.com/NASA-AMMOS/MMGIS`



1. From within `/`  

   `npm install`



### Building



To build the Docker image, run:

`docker build -t  .`



### Preparing



#### .env



- Copy `/sample.env` to `.env`  

   `cp sample.env .env`

- Open `.env` and update the following:



  ```

  DB_NAME=

  DB_USER=

  DB_PASS=

  ```



  From the install example:



  ```

  DB_NAME=db

  DB_USER=postgres

  DB_PASS=

  ```



- Set all the ENV variables in `.env`. More information about the ENVs can be found [here.](https://nasa-ammos.github.io/MMGIS/setup/envs)

  - If using the postgis/postgres image from within the docker-compose.yml, set the ENV `DB_NAME` to the name of the service (in this case `db`)



#### docker-compose.yml



This repo contains a `/docker-compose.sample.yml` file that defines a service for the application and a PostgreSQL database with PostGIS installed



- Copy this file to a `docker-compose.yml`.

- In the `db` service in `docker-compose.yml`, set the `POSTGRES_PASSWORD` environment variable and use this for MMGIS's `DB_PASS` ENV value.

- Fill out the other `environment` variables within the `docker-compose.yml` as well.

- To run MMGIS in a container, you need to create a directory on the host machine and map this to a directory in the container.

  - On the host machine, create a `Missions` directory and copy the contents of `./Missions` to your directory.

  - Via the docker-compose.yml, map this directory to `/usr/src/app/Missions` in the container. For example, if the host directory is `./Missions`, the volume mapping would be `- ./Missions:/usr/src/app/Missions`

- Note, the `/docker-compose.sample.yml` includes optional STAC and TiTiler services. If any of them are unwanted, they can be removed from the docker-compose-yml and their respective `.env` variable `WITH_{service}` can be set to false.



### Running



Run: `docker-compose up -d`



### First Time UI Setup



1. Setup the admin account:



   - In your browser, navigate to `http://localhost:8888/configure`

   - Sign up for an Administrator account (The Administrator account is always the first user in the database and you are only prompted to create an Administrator account if there are no other users)



1. Now sign in with you Administrator credentials



1. Click `NEW MISSION`  

   Enter a new mission name and click `MAKE MISSION`  

   Optional: (Use the mission name `"Test"` (case-sensitive) to make the sample mission)



Navigate to `http://localhost:8888`.



See the [configuration documentation](https://nasa-ammos.github.io/MMGIS/configure/) for more information on how to use the configure page to customize and add data to MMGIS.



## Installing Without Docker



### System Requirements



1. Install the latest version of [Node.js v20.11.1+](https://nodejs.org/en/download/).



1. Install [PostgreSQL v16+](https://www.enterprisedb.com/downloads/postgres-postgresql-downloads). Detailed [install instructions](https://www.postgresqltutorial.com/postgresql-getting-started/) for all platforms.

1. Install [PostGIS 3+](https://postgis.net/install/). From the above install, you can use the 'Application Stack Builder' to install PostGIS or the default [PostGIS install instructions](https://postgis.net/install/) for all platforms.

1. Make a new PostgreSQL database and remember the user, password and database name.

   Use 'psql' or the 'SQL Shell' to log into Postgres. It will prompt you for the username and password made during the install.



#### Python Environment



1. Install [micromamba 2+](https://mamba.readthedocs.io/en/latest/installation/micromamba-installation.html)

   #### Windows:

   1. In powershell run:

      ```

      Invoke-Expression ((Invoke-WebRequest -Uri https://micro.mamba.pm/install.ps1).Content)

      ```

   1. Initialize the shell with:

      ```

      micromamba shell init --shell cmd.exe --root-prefix=your\path\to\mamba

      ```

   1. In a command window in the MMGIS root directory run:

      ```

      micromamba env create -y --name mmgis --file=python-environment.yml

      ```

      - If you encounter an error like: `..\mamba\condabin\micromamba"' is not recognized as an internal or external command, operable program or batch file.`, then copy the `mamba.bat` file in that directory to `micromamba.bat`

   1. Confirm the installation and initialization went well with:

      ```

      micromamba run -n mmgis gdalinfo --version

      ```

   1. Activate the environment before running `npm start`

      ```

      micromamba activate mmgis

      ```

   #### Legacy (without micromamba):

   - GDAL [3.4+](https://gdal.org/download.html) with Python bindings (Windows users may find [these](https://github.com/cgohlke/geospatial-wheels/releases) helpful)

   - Python [>=3.10 and <3.13](https://www.python.org/downloads/)

   - From root MMGIS directory: `python -m pip install -r python-requirements.txt`

   - Ensure your `PROJ_LIB` system ENV points to the proj.db install through python.

   - Note: MMGIS expects and uses the command `python` only and not `python3` or variations.



### Setup



`/` will always refer to the repo's root directory



1. Clone the repo  

   `git clone https://github.com/NASA-AMMOS/MMGIS`



1. From within `/`  

   `npm install`



1. Copy `/sample.env` to `.env`  

   `cp sample.env .env`



1. Open `.env` and update the following:



   ```

   DB_NAME=

   DB_USER=

   DB_PASS=

   ```



   From the install example:



   ```

   DB_NAME=mmgis

   DB_USER=postgres

   DB_PASS=

   ```



1. Run `npm run build` to bundle up the code (first time or if there are any changes)



1. Go into /configure and run `npm install` followed by `npm run build` to build the configuration site.



1. Go back to the root `/` directory



1. Run `micromamba activate mmgis` or `python -m pip install -r python-requirements.txt` (if not using python environments)



1. If using adjacent-servers (titiler, stac, ...) make `.env` files from the samples within the `/adjacent-servers/{servers}/` directory.



1. Run `npm run start:prod`



1. Setup the admin account:



   - In your browser, navigate to `http://localhost:8888/configure`

   - Sign up for an Administrator account (The Administrator account is always the first user in the database and you are only prompted to create an Administrator account if there are no other users)



1. Now sign in with you Administrator credentials



1. Click `NEW MISSION`  

   Enter a new mission name and click `MAKE MISSION`  

   (Use the mission name `"Test"` (case-sensitive) to make the sample mission)



Go to `http://localhost:8888` to see the `Test` mission



_Note:_ The development environment (`npm start`) and only the development environment uses two port numbers `8888` and `8889` (by default) — the latter for the main site and the former for the ancillary pages (such as `/configure` and `/docs`)



---



## Scripts



### Production



1. Run `npm run build` to bundle up the code (first time or if there are any changes)



1. Run `micromamba activate mmgis`(if applicable)



1. Run `npm run start:prod`



### Development



1. Run `micromamba activate mmgis`(if applicable)



1. Run `npm start`



### Test



1. Run `npm run test`  

   _Note:_ Jest has just been added in v2.0.0 and test suites are still very limited. There is strong interest to move to Playwright.



---



## Documentation



### [The latest online documentation can be found here.](https://nasa-ammos.github.io/MMGIS/)



Additionally, documentation pages are served at `http://localhost:8888/docs` or immediately within the [`docs/pages/markdowns`](/docs/pages/markdowns) directory.



---



## Contributing



Check out our contributing guide [here.](CONTRIBUTING.md)



---



## Code of Conduct



Check out our code of conduct [here.](CODE_OF_CONDUCT.md)



---



### License: Apache 2.0 (https://www.apache.org/licenses/LICENSE-2.0)



Copyright (c) 2024, California Institute of Technology ("Caltech"). U.S. Government sponsorship acknowledged.



All rights reserved.



Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:



- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

- Redistributions must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

- Neither the name of Caltech nor its operating division, the Jet Propulsion Laboratory, nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.



THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.



---



## Contacts



Dr. Fred J. Calef III - fred.calef@jpl.nasa.gov  

Tariq K. Soliman - tariq.k.soliman@jpl.nasa.gov



Or join us on **[Slack](https://nasa-ammos.slack.com/archives/C076L0Q1P4H)**