Installation

NcCut can be downloaded directly from PyPI using PIP:

  1. It is recommended to first create a virtual environment before installing packages on your system to prevent package compatibility issues. From the terminal at your desired directory use:

    • For Linux and Mac:

      python3 -m venv nccut-venv
      source nccut-venv/bin/activate
      
    • For Windows:

      python -m venv nccut-venv
      nccut-venv\Scripts\activate
      
  2. Then install NcCut using PIP:

    pip install nccut
    
  3. To run the app there are two options:

    • From the command Line:

      nccut
      

      You can also pass a NetCDF or image file directly into the app via the command line:

      nccut -file file_name
      
    • From Python:

      from nccut.nccut import NcCut
      NcCut().run()
      

    Note

    The first run after installation may be slow as underlying packages must unpack and compile. Future runs should open much quicker.

  4. To exit the virtual environment when finished:

    deactivate
    
  5. To open the same virtual environment again in the future:

    • For Linux and Mac:

      source nccut-venv/bin/activate
      
    • For Windows:

      nccut-venv\Scripts\activate
      

Troubleshooting

  • You will need to have python of version at least 3.9 installed on your computer

  • Ensure you have X11 on your computer (not always the case on Macs)

  • There is occasionally a bug with the way kivy accesses it’s dependencies. If the app won’t run for you try running these lines in the terminal:

    pip uninstall kivy kivy.deps.sdl2 kivy.deps.glew kivy.deps.gstreamer image
    pip install --upgrade pip wheel setuptools
    pip install docutils pygments pypiwin32 kivy.deps.sdl2 kivy.deps.glew --extra-index-url https://kivy.org/downloads/packages/simple/
    pip install kivy
    

Support

Stuck? Reach out to rchartra@uw.edu