Verified Commit 44ce11af authored by David Hoese's avatar David Hoese
Browse files

Update README to reflect new changes and point to Wiki

parent 5673254d
How to Contribute
=================
Information on contributing to SIFT can be found on our
[GitHub Wiki](https://github.com/ssec/sift/wiki/Contributing).
\ No newline at end of file
# SIFT
Satellite Information Familiarization Tool (SIFT) was designed by the SSEC to
support scientists during forecaster training events. It provides a graphical
interface for visualization and basic analysis of geostationary satellite data.
SIFT is built on open source technologies like Python, OpenGL, and PyQt5. It
can be run from Mac, Windows, and Linux. The SIFT application is provided as
a python library called "uwsift". It can also be installed as a standalone
application.
SIFT's main website is http://sift.ssec.wisc.edu/.
The Git repository where you can find SIFT's source code, issue tracker, and
other documentation is on GitHub: https://github.com/ssec/sift
The project wiki with some in-depth usage and installation instructions can
also be found on GitHub: https://github.com/ssec/sift/wiki
Developer documentation can be found on https://sift.readthedocs.io/en/latest/.
## Data Access and Reading
SIFT uses the open source python library Satpy to read input data. By using
Satpy SIFT is able to read many satellite instrument file formats, but may not
be able to display or understand all data formats that Satpy can read. SIFT
defaults to a limited set of readers for loading satellite instrument data.
This set of readers includes but is not limited to:
* GOES-R ABI Level 1b
* Himawari AHI HRIT
* Himawari AHI HSD
* GEO-KOMPSAT-2 AMI Level 1b
Other readers can be accessed from SIFT but this is considered an advanced
usage right now.
## Installation
See the SIFT GitHub page (linked above) for more information on the various
installation methods and download options for SIFT.
## Usage
SIFT can be installed as a python package or from an all-in-one installer
which bundles all dependencies for easy installation. The following
instructions describe how to run SIFT from the all-in-one installer on the
three supported platforms.
### Running on Windows
Once installed through the downloaded installation wizard ``.exe``, SIFT
can be started from the "SIFT" shortcut in the start menu. By default SIFT
caches files in a "workspace" located at the user's
`/Users/<User>/AppData/Local/CIMSS-SSEC/SIFT/Cache/workspace` directory.
Configuration files for the application are stored in the user's
`/Users/<User>/AppData/Roaming/CIMSS-SSEC/SIFT/settings` directory.
### Running on Linux
The downloaded tarball `.tar.gz` can be extracted by running:
tar -xf SIFT_X.Y.Z.tar.gz
SIFT can then be started by running the `SIFT/SIFT` executable. Run
`SIFT/SIFT -h` for available command line options.
If SIFT will not start please ensure that the `LD_LIBRARY_PATH` environment
variable is not set.
SIFT will cache files in a `~/.cache/SIFT` directory and configuration
files in a `~/.config/SIFT` directory.
### Running on Mac
The downloaded DMG file can be extracted opened by double clicking on it.
The available `.app` should then be moved to the appropriate `Applications`
folder. Due to Apple developer application signing limitations, the `.app`
must first be opened by right clicking and clicking "Open". After SIFT is
opened for the first time double clicking the `.app` icon from `Applications`
will execute SIFT as usual.
SIFT will cache files in a `~/Library/Caches/SIFT` directory and configuration
files in a `~/Library/Application Support/SIFT` directory.
SIFT
====
# SIFT
Satellite Information Familiarization Tool (SIFT) was designed by the SSEC to
support scientists during forecaster training events. It provides a graphical
interface for visualization and basic analysis of geostationary satellite data.
TODO: Add coveralls, pypi, travis, gitter, and other badges
SIFT is built on open source technologies like Python, OpenGL, and PyQt4. It
can be run from Mac, Windows, and Linux.
Satellite Information Familiarization Tool (SIFT) was designed by the Space
Science and Engineering Center (SSEC) at the University of Wisconsin - Madison
to support scientists during forecaster training events. It provides a
graphical interface for visualization and basic analysis of geostationary
satellite data.
The main website is http://sift.ssec.wisc.edu/.
SIFT is built on open source technologies like Python, OpenGL, and PyQt5. It
can be run from Mac, Windows, and Linux. The SIFT application is provided as
a python library called "uwsift". It can also be installed as a standalone
application.
The Git repository is available on GitHub: https://github.com/ssec/sift
SIFT's main website is http://sift.ssec.wisc.edu/.
The Git repository where you can find SIFT's source code, issue tracker, and
other documentation is on GitHub: https://github.com/ssec/sift
The project wiki with some in-depth usage and installation instructions can
also be found on GitHub: https://github.com/ssec/sift/wiki
Developer documentation can be found on https://sift.readthedocs.io/en/latest/.
## Data Access and Reading
Data Access
-----------
SIFT currently accepts a limited number of input formats. It is able to load
NetCDF4 L1B files for the GOES-16 ABI instrument. It will accept more input
files in the future. Please contact Jordan Gerth, Ray Garcia, or David Hoese
to get access to this early release data set.
Installation
------------
SIFT installers and bundles are available on the SIFT FTP location:
ftp://ftp.ssec.wisc.edu/pub/sift/dist
The Windows installers end in `.exe`, Linux with `.tar.gz`, and Mac OSX with
`.dmg`. See the sections below for details on installing SIFT for each
operating system.
### Run on Windows
After executing the downloaded `.exe` installer follow the installation
wizard to install SIFT. SIFT can then be run from the "SIFT" shortcut
in the start menu. By default SIFT caches files in a "workspace" located
at the user's
`/Users/<User>/AppData/Local/CIMSS-SSEC/SIFT/Cache/workspace` directory.
Configuration files for the application are stored in the user's
`/Users/<User>/AppData/Roaming/CIMSS-SSEC/SIFT/settings` directory.
### Run on Linux
The downloaded tarball `.tar.gz` can be extracted by running:
tar -xf SIFT_X.Y.Z.tar.gz
SIFT can then be run by executing the `SIFT/SIFT`. Run `SIFT/SIFT -h`
for available command line options.
If SIFT will not start please ensure that the `LD_LIBRARY_PATH` environment
variable is not set.
SIFT will cache files in a `~/.cache/SIFT` directory and configuration
files in a `~/.config/SIFT` directory.
### Run on Mac
SIFT uses the open source python library Satpy to read input data. By using
Satpy SIFT is able to read many satellite instrument file formats, but may not
be able to display or understand all data formats that Satpy can read. SIFT
defaults to a limited set of readers for loading satellite instrument data.
This set of readers includes but is not limited to:
The downloaded DMG file can be extracted opened by double clicking on it.
The available `.app` should then be moved to the appropriate `Applications`
folder. Due to Apple developer application signing limitations, the `.app`
must first be opened by right clicking and clicking "Open". After SIFT is
opened for the first time double clicking the `.app` icon from `Applications`
will execute SIFT as usual.
* GOES-R ABI Level 1b
* Himawari AHI HRIT
* Himawari AHI HSD
* GEO-KOMPSAT-2 AMI Level 1b
SIFT will cache files in a `~/Library/Caches/SIFT` directory and configuration
files in a `~/Library/Application Support/SIFT` directory.
Other readers can be accessed from SIFT but this is considered an advanced
usage right now.
## Installation
### Installing with Conda
SIFT can be installed as an all-in-one bundled application or the python
library "uwsift" can be installed in a traditional python environment.
SIFT can also be installed with the Anaconda/Conda package manager. Python
3.7 is currently the only supported python environment. It can be installed by
running:
Detailed installation instructions can be found on the
[GitHub Wiki](https://github.com/ssec/sift/wiki/Installation-Guide).
conda install -c http://larch.ssec.wisc.edu/channels/sift uwsift
And then run with:
## Contributors
python -m uwsift
The `-h` flag can be added for documentation on additional command line
options.
SIFT is an open source project welcoming all contributions. See the
[Contributing Guide](https://github.com/ssec/sift/wiki/Contributing)
for more information on how you can help.
### Building and releasing
For instructions on how SIFT is built and packaged see the
[releasing instructions](RELEASING.md). Note that these instructions
are mainly for SIFT developers and may require technical understanding of
SIFT and the libraries it depends on.
\ No newline at end of file
SIFT and the libraries it depends on.
# Releasing SIFT
1. Checkout master (`git checkout master`)
2. Pull from repository (`git pull`)
The following instructions will walk you through making a release of the
SIFT application and python library. These instructions assume that you
already have the SIFT git repository cloned from GitHub and that the
`origin` git remote is pointing to the `ssec/sift` repository. Instructions
must be adjusted if `origin` points to your fork of the `sift` repository.
1. Make sure you are on the master branch (`git checkout master`)
2. Pull the most recent changes (`git pull`)
3. Run any necessary tests. For basic dependency checks `python sift -h`
should suffice.
4. Run `loghub` and update the `CHANGELOG.md` file. If `loghub` is not
......@@ -11,7 +17,7 @@
loghub ssec/sift -u <username> -st 1.0.5 -plg bug "Bugs fixed" -plg enhancement "Features added" -plg documentation "Documentation changes" -plg backwards-incompatibility "Backwards incompatible changes"
```
5. Commit the change log changes.
5. Commit the changelog changes.
6. Bump the version of the package:
......
......@@ -168,10 +168,14 @@ class BumpCommand(Command):
print("To push git changes to remote, run:\n git push --follow-tags")
readme = open(os.path.join(script_dir, 'README.md')).read()
setup(
name='uwsift',
version=version_str,
description="Satellite Information Familiarization Tool",
long_description=readme,
long_description_content_type='text/markdown',
author='R.K.Garcia, University of Wisconsin - Madison Space Science & Engineering Center',
author_email='rkgarcia@wisc.edu',
url='https://github.com/ssec/sift',
......@@ -181,6 +185,7 @@ setup(
"or later (GPLv3+)",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Topic :: Scientific/Engineering"],
zip_safe=False,
include_package_data=True,
......
......@@ -12,12 +12,12 @@ OutputDir=sift_inno_setup_output
[Files]
Source: "dist\SIFT\*"; DestDir: "{app}\bin"; Flags: replacesameversion recursesubdirs
Source: "README.md"; DestName: "README.txt"; DestDir: "{app}"; Flags: isreadme; AfterInstall: ConvertLineEndings
Source: "INSTALLER_README.md"; DestName: "README.txt"; DestDir: "{app}"; Flags: isreadme; AfterInstall: ConvertLineEndings
[Icons]
Name: "{group}\SIFT"; Filename: "{app}\bin\SIFT.exe"
Name: "{group}\Bug Tracker"; Filename: "https://gitlab.ssec.wisc.edu/SIFT/sift/issues"
Name: "{group}\Wiki"; Filename: "https://gitlab.ssec.wisc.edu/SIFT/sift/wikis/home"
Name: "{group}\Bug Tracker"; Filename: "https://github.com/ssec/sift/issues"
Name: "{group}\Wiki"; Filename: "https://github.com/ssec/sift/wiki"
Name: "{group}\Open Workspace Folder"; Filename: "{%WORKSPACE_DB_DIR}"
Name: "{group}\Open Settings Folder"; Filename: "{%DOCUMENT_SETTINGS_DIR}"
Name: "{group}\Uninstall SIFT"; Filename: "{uninstallexe}"
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment