<commit_before># Openmod's Python Toolchest

This project serves as a catch-all for openmod devs' useful python tools and
APIs (though we are generally language lovers and are not limited to Python
specifically).

For the foreseeable future, this repo is a bit adhoc -- anything of use that fits
the general theme of energy modeling is welcome. We try to split additions by
subject into the appropriate files (e.g., GIS-related work to `gis.py`, etc.).

The contributors to this repository strive to write clear, understandable,
tested, and documented code. We recognize this requires a nontrivial effort and
respect the effort of others by being willing to review pull requests and
otherwise offer comments, critiques, and first-user experiences.

## Communication

Apart from using the issue tracker, please join the
[listserv](https://groups.google.com/forum/#!forum/openmod-initiative) for any
in depth discussions.

## Dependencies

As this is a hodgepodge of tools, different tooling requires different
dependencies.

### General

0. numpy
0. pandas
0. scipy

### GIS

0. fiona
0. rasterio
0. shapely

### Modeling & Optimization

0. pyomo

### Testing

0. `nose <https://pypi.python.org/pypi/nose/1.3.7>`_

### Documentation

0. `Sphinx <https://pypi.python.org/pypi/Sphinx>`_

## Installing

You can install `toolchest` like any other python module::

    ./setup.py install

or for local installations::

    ./setup.py install --user

## Testing

From the root directory, run::

    nosetests -w tests

## Documentation

### On *Nix Platforms

After you install the project locally, you can generate documentation by::

    cd docs
    make html

You can serve the documentation locally via::

    make serve
	
You can then view the docs at http://localhost:8000/build/html/

### On Windows

Follow the above instructions replacing ``make`` with ``./make.bat``.<commit_msg>fixed links and code blocks<commit_after># Openmod's Python Toolchest

This project serves as a catch-all for openmod devs' useful python tools and
APIs (though we are generally language lovers and are not limited to Python
specifically).

For the foreseeable future, this repo is a bit adhoc -- anything of use that fits
the general theme of energy modeling is welcome. We try to split additions by
subject into the appropriate files (e.g., GIS-related work to `gis.py`, etc.).

The contributors to this repository strive to write clear, understandable,
tested, and documented code. We recognize this requires a nontrivial effort and
respect the effort of others by being willing to review pull requests and
otherwise offer comments, critiques, and first-user experiences.

## Communication

Apart from using the issue tracker, please join the
[listserv](https://groups.google.com/forum/#!forum/openmod-initiative) for any
in depth discussions.

## Dependencies

As this is a hodgepodge of tools, different tooling requires different
dependencies.

### General

0. numpy
0. pandas
0. scipy

### GIS

0. fiona
0. rasterio
0. shapely

### Modeling & Optimization

0. pyomo

### Testing

0. [nose](https://pypi.python.org/pypi/nose/1.3.7)

### Documentation

0. [Sphinx](https://pypi.python.org/pypi/Sphinx)

## Installing

You can install `toolchest` like any other python module

```
./setup.py install
```

or for local installations

```
./setup.py install --user
```

## Testing

From the root directory, run

```
nosetests -w tests
```

## Documentation

### On *Nix Platforms

After you install the project locally, you can generate documentation by

```
cd docs
make html
```

You can serve the documentation locally via

```
make serve
```

You can then view the docs at http://localhost:8000/build/html/

### On Windows

Follow the above instructions replacing ``make`` with ``./make.bat``.
{'fraction_non_alphanumeric': 0.09098122189896853, 'fraction_numerical': 0.008463369478973817, 'mean_word_length': 4.05614973262032, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2690066', 'n_tokens_mistral': 1149, 'n_tokens_neox': 1061, 'n_words': 485}