Metadata-Version: 2.4
Name: tethys-platform
Version: 4.5.1
Summary: Primary Tethys Platform Django Site Project
Author-email: Nathan Swain <nswain@aquaveo.com>, Scott Christensen <ScottyChristensen@gmail.com>
Project-URL: homepage, http://tethysplatform.org/
Project-URL: documentation, http://docs.tethysplatform.org/en/stable/
Project-URL: repository, https://github.com/tethysplatform/tethys
Keywords: web app,scientific,geospatial
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyopenssl
Requires-Dist: django<6,>=4.2
Requires-Dist: tornado<7,>=6.5
Requires-Dist: channels
Requires-Dist: daphne
Requires-Dist: requests<3,>=2.32.4
Requires-Dist: bcrypt
Requires-Dist: cryptography>=46.0.5
Requires-Dist: pyyaml
Requires-Dist: jinja2
Requires-Dist: django-bootstrap5
Requires-Dist: django-model-utils
Requires-Dist: django-guardian
Requires-Dist: djangorestframework_simplejwt
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-django; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: requests_mock; extra == "test"
Provides-Extra: lint
Requires-Dist: flake8; extra == "lint"
Requires-Dist: black; extra == "lint"
Dynamic: license-file

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/tethysplatform/tethys/main/docs/images/features/tethys-on-blue.svg">
  <img alt="Tethys Platform Logo" src="https://raw.githubusercontent.com/tethysplatform/tethys/main/docs/images/features/tethys-on-white.svg">
</picture>

[![Test Status](https://github.com/tethysplatform/tethys/actions/workflows/tethys.yml/badge.svg)](https://github.com/tethysplatform/tethys/actions)
[![Coverage Status](https://coveralls.io/repos/github/tethysplatform/tethys/badge.svg?branch=main)](https://coveralls.io/github/tethysplatform/tethys?branch=main)
[![Documentation Status](https://readthedocs.org/projects/tethys-platform/badge/?version=stable)](http://docs.tethysplatform.org/en/stable/?badge=stable)
[![Buy us a soda](https://img.shields.io/badge/🥤-Buy%20Us%20a%20Soda-0a62a9)](https://www.buymeacoffee.com/tethysplatform)

Tethys Platform provides both a development environment and a hosting environment for geoscientific web apps.

## Installation

### Quick Start

First create a virtual environment with the tool of your choice, then download and install Tethys Platform using one of the following methods:

**Using Conda (Recommended):**
```bash
conda install -c conda-forge tethys-platform
tethys quickstart
```

**Using Pip:**
```bash
pip install tethys-platform
tethys quickstart
```

The `tethys quickstart` command will set up your development environment and start the server. Your browser will automatically open to [http://127.0.0.1:8000/](http://127.0.0.1:8000/).

**Default Login:**
- Username: admin
- Password: pass

### Detailed Installation

For more detailed installation instructions, including database configuration and production deployment, see our [Detailed Installation documentation](https://docs.tethysplatform.org/en/stable/installation.html).

## Next Steps

There are several directions you may want to go from here:

- **Learn to develop apps**: Complete one or more [Tutorials](https://docs.tethysplatform.org/en/stable/tutorials.html) to learn how to develop apps using Tethys Platform
- **See live examples**: Install the [Showcase Apps](https://docs.tethysplatform.org/en/stable/installation/showcase_apps.html) to see live demos and code examples of Gizmos and Layouts
- **Install existing apps**: Use the [Application Installation](https://docs.tethysplatform.org/en/stable/installation/application.html) guide to install apps you have already developed
- **Customize your portal**: Check out the [Web Admin Setup](https://docs.tethysplatform.org/en/stable/installation/web_admin_setup.html) docs to customize your Tethys Portal
- **Use Docker**: For help getting started with Docker, see [Using Docker](https://docs.tethysplatform.org/en/stable/installation/using_docker.html)
- **Full documentation**: Browse the complete [documentation](https://docs.tethysplatform.org/en/stable/) for comprehensive guides and API references

## Support Development

If Tethys Platform is useful to you, consider supporting development by [buying the developers a soda](https://www.buymeacoffee.com/tethysplatform).

## Acknowledgments

This material is based upon work supported by the National Science Foundation under Grants [EPS-1135482](https://www.nsf.gov/awardsearch/showAward?AWD_ID=1135482) and [TI-2303756](https://www.nsf.gov/awardsearch/showAward?AWD_ID=2303756).
