Spatial Data Infrastructure for Planetary Missions

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

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

2. From within /
npm install

Building

To build the Docker image, run: docker build -t <image tag> .

Preparing

.env

• Copy /sample.env to .env
cp sample.env .env
• Open .env and update the following:

DB_NAME=<name> DB_USER=<user> DB_PASS=<password>

From the install example:

DB_NAME=db DB_USER=postgres DB_PASS=<POSTGRES_PASSWORD (see below)>

• Set all the ENV variables in .env. More information about the ENVs can be found here.
  • 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

2. 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 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+.

2. Install PostgreSQL v16+. Detailed install instructions for all platforms.

3. Install PostGIS 3+. From the above install, you can use the 'Application Stack Builder' to install PostGIS or the default PostGIS install instructions for all platforms.

4. 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+ #### Windows:
   1. In powershell run: Invoke-Expression ((Invoke-WebRequest -Uri https://micro.mamba.pm/install.ps1).Content)
   2. Initialize the shell with: micromamba shell init --shell cmd.exe --root-prefix=your\path\to\mamba
   3. 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
   4. Confirm the installation and initialization went well with: micromamba run -n mmgis gdalinfo --version
   5. Activate the environment before running npm start micromamba activate mmgis #### Legacy (without micromamba):
   6. GDAL 3.4+ with Python bindings (Windows users may find these helpful)
   7. Python >=3.10 and <3.13
   8. From root MMGIS directory: python -m pip install -r python-requirements.txt
   9. Ensure your PROJ_LIB system ENV points to the proj.db install through python.
   10. 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

2. From within /
npm install

3. Copy /sample.env to .env
cp sample.env .env

4. Open .env and update the following:

DB_NAME=<name> DB_USER=<user> DB_PASS=<password>

From the install example:

DB_NAME=mmgis DB_USER=postgres DB_PASS=<password>

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

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

3. Go back to the root / directory

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

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

6. Run npm run start:prod

7. 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

2. 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)

2. Run micromamba activate mmgis(if applicable)

3. Run npm run start:prod

Development

1. Run micromamba activate mmgis(if applicable)

2. 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.

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

Contributing

Check out our contributing guide here.

Code of Conduct

Check out our code of conduct here.

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