Metadata-Version: 2.4
Name: idmtools_platform_general
Version: 3.0.0
Summary: General platform for IDM-Tools
Author-email: Zhaowei Du <zdu@idmod.org>, Sharon Chen <shchen@idmod.org>, Clinton Collins <ccollins@idmod.org>, Jen Schripsema <jschripsema@idmod.org>, Ross Carter <rcarter@idmod.org>
Project-URL: Homepage, https://github.com/InstituteforDiseaseModeling/idmtools
Keywords: modeling,IDM
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.TXT
Requires-Dist: idmtools~=3.0.0
Requires-Dist: idmtools_cli~=3.0.0
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: matplotlib; extra == "test"
Requires-Dist: pytest-timeout; extra == "test"
Requires-Dist: pytest-cache; extra == "test"
Requires-Dist: pytest-lazy-fixture; extra == "test"
Requires-Dist: flake8; extra == "test"
Requires-Dist: coverage; extra == "test"
Requires-Dist: bump2version; extra == "test"
Requires-Dist: twine; extra == "test"
Requires-Dist: natsort; extra == "test"
Requires-Dist: idmtools_models; extra == "test"
Requires-Dist: idmtools_test; extra == "test"
Provides-Extra: packaging
Requires-Dist: flake8; extra == "packaging"
Requires-Dist: coverage; extra == "packaging"
Requires-Dist: bump2version; extra == "packaging"
Requires-Dist: twine; extra == "packaging"
Requires-Dist: natsort; extra == "packaging"
Dynamic: license-file

![Staging: idmtools-platform-file](https://github.com/InstituteforDiseaseModeling/idmtools/workflows/Staging:%20idmtools-platform-file/badge.svg?branch=dev)

# idmtools-platform-general

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**

  - [Installing](#installing)
- [Development Tips](#development-tips)
- [Use Cases](#use-cases)
- [Feature Roadmap](#feature-roadmap)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Installing

```bash
pip install idmtools-platform-general --index-url=https://packages.idmod.org/api/pypi/pypi-production/simple
```

# Development Tips

There is a Makefile file available for most common development tasks. Here is a list of commands

```bash
clean       -   Clean up temproary files
lint        -   Lint package and tests
test        -   Run All tests
coverage    -   Run tests and generate coverage report that is shown in browser
```

On Windows, you can use `pymake` instead of `make`

# Use Cases

* Testing
  * Test core functionality
  * Performance Testing
* Integration with other systems
  * Other HPC Systems
  * Local Executions Systems
  * Jupyter notebooks
* Basis for future local platforms
  * Process
  * Thread
  * Dask
  * Asyncio

# Feature Roadmap

* First Version
  * Support for basic provisioning on a linux filesystem
