Metadata-Version: 2.1
Name: sambaflux
Version: 0.1.1
Summary: Sampling Biomarker Analysis using flux sampling
Home-page: https://github.com/pypa/sampleproject
Author: Example Author
Author-email: Juliette Cooke <juliette.cooke@inrae.fr>
License: MIT License
        
        Copyright (c) 2022 metexplore / cbm
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://forgemia.inra.fr/metexplore/cbm/samba/-/tree/main/sambaflux
Project-URL: Bug Tracker, https://forgemia.inra.fr/metexplore/cbm/samba/-/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Unix
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# SAMBAflux
## Description
SAMpling Biomarker Analysis is a python package for running flux sampling on metabolic networks.

## Visuals
[add example plots here]

## Getting started
### Requirements

- Python 3.7+
- cobrapy
- A solver (GLPK, CPLEX, GUROBI)
- Access to a computer cluster or powerful computer


### Installation
Install via pip:  

```bash
pip install sambaflux
```

## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of 
usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.

## Confirmed working models

## Roadmap
- [x] Add support for multiple KOs at once
- [ ] Add the option to reduce flux rates in addition to KO


## Authors
Juliette Cooke

## Acknowledgments


## License
MIT License (see LICENSE file)

## Project status
Currently active on this project. 
