Permalink
Browse files

Added directory tree to git readme and added links to the documentation

site.
  • Loading branch information...
1 parent 81c8b33 commit 26fc7d43bd2073401dd6c37b2c1ba985fb97f1a4 @davidh-ssec committed Dec 3, 2012
Showing with 47 additions and 8 deletions.
  1. +47 −8 README.rst
View
@@ -1,20 +1,59 @@
-polar2grid
+POLAR2GRID
==========
-polar2grid is a software package, mainly python, for converting polar
-orbitting satellite data from various sources (VIIRS, MODIS, etc.) into
+Polar2grid is a software package for converting polar-orbitting satellite
+data from various sources (VIIRS, MODIS, etc.) into
formats that are useable by meteorlogical visualization applications,
-such as AWIPS, NINJO, etc.
+such as AWIPS, NINJO, WMS, etc.
-Currently, polar2grid only works on converting a few VIIRS bands to
-AWIPS-compatible NetCDF files.
+The main code repository is hosted at https://github.com/davidh-ssec/polar2grid
+
+The main documentation site is http://www.ssec.wisc.edu/software/polar2grid/
+
+Directory Structure
+-------------------
+
+. git root
+├── ms2gt
+│   └── # custom polar2grid version of ms2gt
+├── py
+│   ├── # Python packages and scripts
+│   ├── misc
+│   │ └── # miscellaneous files
+│   ├── polar2grid
+│   │   ├── doc
+│   │   │   └── # Sphinx documentation files for main documentation site
+│   │   └── polar2grid
+│   │     ├── # 'Main' python package (highest on dependency tree)
+│   │      ├── awips
+│ │ │ ├── # AWIPS backend code
+│   │      │   └── ncml
+│   │      │   └── # NCML templates for the AWIPS backend
+│   │      └── grids
+│   │      └── # Grids subpackage, includes gpd files and grid configuration files
+│   ├── polar2grid_core
+│   │   └── polar2grid
+│   │      └── core
+│   │      ├── # 'Core' python package (lowest on dependency tree)
+│   │      └── rescale_configs
+│   │      └── # Rescaling configuration files (\*.conf)
+│   ├── polar2grid_viirs
+│   │   └── polar2grid
+│   │      └── viirs
+│   │      └── # VIIRS frontend package (middle of the dependency tree)
+│   └── util
+│   └── # Python utility scripts not necessary used directly with polar2grid
+├── swbundle
+│   └── # Bash scripts and text files for the './bin' directory of the software bundle
+└── swbundle_tests
+    └── # Bash scripts (run/verify) for the test bundles
SVN Conversion Notes
--------------------
The original repository included a "vendor" directory in the root repository
that was being used to store the vendor release of ms2gt. The repository was
converted to git using "svn2git" which does not support this structure.
-For now, the "vendor" directory is not included in the git repository although
-it may be added later.
+For now, the "vendor" directory is represented by the ``ms2gt`` directory in
+the root of the git repository.

0 comments on commit 26fc7d4

Please sign in to comment.