Metadata-Version: 2.1
Name: pyincore_viz
Version: 1.11.0
Summary: IN-CORE visualization python package
Home-page: https://incore.ncsa.illinois.edu
License: Mozilla Public License v2.0
Project-URL: Bug Reports, https://github.com/IN-CORE/pyincor-vize/issues
Project-URL: Source, https://github.com/IN-CORE/pyincor-vize
Keywords: infrastructure,resilience,hazards,data discovery,IN-CORE,earthquake,tsunami,tornado,hurricane,dislocation
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: branca>=0.3.0
Requires-Dist: contextily>=1.0.0
Requires-Dist: deprecated
Requires-Dist: geopandas>=0.14.0
Requires-Dist: ipyleaflet>=0.16.0
Requires-Dist: ipywidgets>=7.6.0
Requires-Dist: lxml>=4.6.3
Requires-Dist: matplotlib>=3.8.3
Requires-Dist: networkx>=3.2.1
Requires-Dist: numpy<2.0a0,>=1.26.0
Requires-Dist: owslib>=0.17.1
Requires-Dist: pandas>=2.1.2
Requires-Dist: pillow
Requires-Dist: pyincore>=1.11.0
Requires-Dist: rasterio>=1.3.9
Provides-Extra: test
Requires-Dist: pycodestyle>=2.6.0; extra == "test"
Requires-Dist: pytest>=3.9.0; extra == "test"
Requires-Dist: python-jose>=3.0; extra == "test"

pyincore-viz
============

**pyincore-viz** is a component of IN-CORE that provides visualization and other utilities for use with **pyincore**.
 

Mac specific notes
------------------

- We use `matplotlib` library to create graphs. There is a Mac specific installation issue addressed at `here (1) <https://stackoverflow.com/questions/4130355/python-matplotlib-framework-under-macosx>`_ and 
  `here (2) <https://stackoverflow.com/questions/21784641/installation-issue-with-matplotlib-python>`_. 
  In a nutshell, insert line: `backend : Agg` into `~/.matplotlib/matplotlibrc` file.

Installation with conda
-----------------------

Installing **pyincore-viz** with Conda is officially supported by IN-CORE development team. 

To add `conda-forge <https://conda-forge.org/>`__  channel to your environment, run

.. code-block:: console

   conda config –-add channels conda-forge

To install **pyincore-viz** package, run

.. code-block:: console

   conda install -c in-core pyincore-viz


To update **pyIncore-viz**, run

.. code-block:: console

   conda update -c in-core pyincore-viz


Installation with pip
-----------------------

Installing **pyincore-viz** with pip is **NOT supported** by IN-CORE development team.
Please use pip for installing pyincore-viz at your discretion. 

**Installing pyincore-viz with pip is only tested on linux environment.**

**Prerequisite**

* GDAL C library must be installed to install pyincore-viz. (for Ubuntu, **gdal-bin** and **libgdal-dev**)
* For developers, pre-install must be installed. If not, run `brew install pre-commit` or `pip install pre-commit`.

To install **pyincore-viz** package, run

.. code-block:: console

   pip install pyincore-viz

Documentation Containter
------------------------

To build the container with the documentation you can use:

.. code-block:: console

   docker build -t doc/pyincore-viz -f Dockerfile.docs .
   docker run -ti -p 8000:80 doc/pyincore-viz


Then check the documentation at `http://localhost:8000/doc/pyincore_viz/ <http://localhost:8000/doc/pyincore_viz/>`_.
