Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
  • Sign in
  • mapgenerator mapgenerator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributor statistics
    • Graph
    • Compare revisions
  • Issues 30
    • Issues 30
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • Earth SciencesEarth Sciences
  • mapgeneratormapgenerator
  • Wiki
  • how to use

how to use · Changes

Page history
Update how to use authored Jan 28, 2019 by Francesco's avatar Francesco
Hide whitespace changes
Inline Side-by-side
how-to-use.md
View page @ 91aa37cf
MapGenerator provides a huge set of options to plot maps from netCDF file(s) or from multi-dimensional arrays already retrieved and loaded in memory. It can be used basically in two ways: MapGenerator provides a huge set of options to plot maps from netCDF file(s) or from multi-dimensional arrays already retrieved and loaded in memory. It can be used basically in two ways:
1. by command line (needs netCDF to read): 1. by **command line** (needs netCDF to read):
``` ```
mg --help mg --help
...@@ -10,7 +10,7 @@ mg --option1 value1 ... --optionN valueN ...@@ -10,7 +10,7 @@ mg --option1 value1 ... --optionN valueN
mg --option1=value1 ... --optionN=valueN mg --option1=value1 ... --optionN=valueN
``` ```
2. as python library: 2. as **python library**:
``` ```
from mapgenerator.plotting import plotmap from mapgenerator.plotting import plotmap
...@@ -22,7 +22,7 @@ pm.plot(option1=value1, ..., optionN=valueN) (reads from netCDF) ...@@ -22,7 +22,7 @@ pm.plot(option1=value1, ..., optionN=valueN) (reads from netCDF)
pm.aplot(option1=value1, ..., optionN=valueN) (reads from array) pm.aplot(option1=value1, ..., optionN=valueN) (reads from array)
``` ```
Additionally, it can be used as an R library: Additionally, it can be used as an **R library**:
``` ```
library(reticulate) library(reticulate)
...@@ -35,4 +35,16 @@ pm$aplot(option1=value1, ..., optionN=valueN) ...@@ -35,4 +35,16 @@ pm$aplot(option1=value1, ..., optionN=valueN)
``` ```
All available options can be found [here](options) Options can be **passed directly** to the command line or to the functions plot and aplot or can be **stored in configuration files** stored according to the following standard:
```
# comment
[section]
option1 = value1
...
optionN = valueN
```
If options are passed both directly and through configuration file, direct ones have priorities. This can be very useful if you have a set of plots to draw with some options in common and others that change, the constant ones can be stored into one or more configuration files and the others passed directly.
All available options can be found [here](options).
Clone repository
  • Reports
  • configure
  • example1
  • example2
  • example3
  • examples
  • Home
  • how to use
  • options