aa-geo-tools 0.1.26
A python module to wrap pieces of codes developed for and by Anglo American Rapid Resource Modelling team.
Requires Python: >=3.7
Keywords: aa_geo_tools

# AngloAmerican Tools
A python module to wrap pieces of codes used by the Resource modelling team of Anglo American. For now it includes custom jupyter notebook visualization tools for pandas.DataFrame like objects, and coordinate changes.

## Features
    * block models flattening coordinates changes
    * jupyter notebook fancy display tools
    * jupyter notebook self export as html tool
    * equivalent grid computation on block models and composites
    * compressed and uncompressed files handling
    * parametric rendering of Jupyter notebooks content

## TODO
    * block models clusterization procedures


# History
## 0.0.1-0.0.6 (2021-08-19)
    * First release on PyPI.
    * Enriched documentation and block model coordinate operations
    * Jupyter notebook functions on jupyter_display_tools
    * More documentation
    * Contributors instructions + authors
    * Move to md documentation files
    * Assambly/try local developers environment on Python virtualenv and Anaconda virtualenvs

## 0.1.0 (2021-08-20)
    * First stable version

## 0.1.1-9 (2021-08-27)
    * Create rmsp objects from parameters in Datamine format
    * Object like and nn neighbor displacements for Flattening block model coordinates
    * Migration to Azure DevOps git cloud provider
    * Equivalent grid computation
    * Utility for compressed and uncompressed files handling
    * JupyterRender class

## 0.1.10-12 (2021-10-25)
    * Tests for compressed file handlers
    * Fix non relative file locations on compressed file handlers
    * Bokeh section plot visualization tool

## 0.1.13 (2021-11-11)
    * Snippets menu loader

## 0.1.14 (2021-11-24)
    * Moving panel resource validation for RMSP based data sources

## 0.1.15-16 (2021-12-01)
    * Snippets menu loader debugging no custom.js file found
    * Test for resource validation using moving panels
    * More style parameters on scatter plots of moving panels validation

## 0.1.17-19 (2022-01-14)
    * New  mid wall continous flattening approach
    * More functionalities on Jupyter Render.

## 0.1.20 (2022-02-08)
    * Chunks of available memory when computing nearest neighbors of flatteners

## 0.1.21-23 (2022-02-16)
    * RMSP utilities on aa_geo_tools.utils.rmsp_utils
    * Fix mispelling function and approach on Flattener classes
    * Moving panel option to get user defined weights

## 0.1.24-25 (2022-03-16)
    * JupyterRender class compatible with Jupytext percent scripts notebooks
    * Tests for JupyterRender class with sample files
    * JupyterRender negative tests

## 0.1.26 (2022-04-22)
    * Virtual drill holes creator
    * Test for virtual drill holes creator


# Credits
## Development Lead
    * Franco A. Milanese <franco.milanese-externo@angloamerican.com>
# Contributors
    * Carlos H. Zamora <carlos.zamora@angloamerican.com>
    * Paulo H. Faria <paulo.h.faria@angloamerican.com>


# Contributing
Contributions are welcome, and they are greatly appreciated! Every little bit
helps, and credit will always be given.

You can contribute in many ways:

## Types of Contributions
### Report Bugs
Report bugs at https://dev.azure.com/AngloDevOps/RRMWorkflowAutomation/_wiki/wikis/RRMWorkflowAutomation.wiki/6645/aa-geo-tools-bug-list

If you are reporting a bug, please include:

    * Your operating system name and version.
    * Any details about your local setup that might be helpful in troubleshooting.
    * Detailed steps to reproduce the bug.
    * pip freeze output if suitable

### Fix Bugs
Look through the Gitlab issues for bugs. Anything tagged with "bug" and "help
wanted" is open to whoever wants to implement it.

### Implement Features
Look through the Gitlab issues for features. Anything tagged with "enhancement"
and "help wanted" is open to whoever wants to implement it.

### Write Documentation
AngloAmerican Tools could always use more documentation, whether as part of the
official AngloAmerican Tools docs, in docstrings, or even on the web in blog posts,
articles, and such.

#### Submit Feedback
The best way to send feedback is to file an issue at https://dev.azure.com/AngloDevOps/RRMWorkflowAutomation/_wiki/wikis/RRMWorkflowAutomation.wiki/6645/aa-geo-tools-bug-list.

If you are proposing a feature:

* Explain in detail how it would work.
* Keep the scope as narrow as possible, to make it easier to implement.
* Remember that this is a volunteer-driven project, and that contributions
  are welcome :)

## Get Started!
Ready to contribute? Here's how to set up `aa_geo_tools` for local development.

1.
    Fork the `aa_geo_tools` repo on GitHub.

2.
    Clone your fork locally::
    ```
    $ git clone https://AngloDevOps@dev.azure.com/AngloDevOps/RRMWorkflowAutomation/_git/aa-geo-tools
    $ git clone git@ssh.dev.azure.com:v3/AngloDevOps/RRMWorkflowAutomation/aa-geo-tools
    ```

3.
    Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
    ```
    $ mkvirtualenv aa_geo_tools
    $ cd aa_geo_tools/
    $ pip install -e .[dev]
    ```
    if using Anaconda framework you can do something like `conda create --name aa_geo_tools`

4.
    Create a branch for local development:
    ```
    $ git checkout -b name-of-your-bugfix-or-feature
    ```
    Now you can make your changes locally.

5.
    If you want to test the changes in a wrapped version of the package, use
    ```
    $ pip install -e .
    ```
    to install it locally with reference to the local directory. Now you should be able to import it from within a Python console.

6.
    When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
    ```
    $ python setup.py pytest
    ```
   To get flake8 and tox, just pip install them into your virtualenv.

7.
    Commit your changes and push your branch to GitHub:
    ```
    $ git add .
    $ git commit -m "Your detailed description of your changes."
    $ git push origin name-of-your-bugfix-or-feature
    ```

8.
    Submit a pull request through the
    [Azure DevOps website](https://dev.azure.com/AngloDevOps/RRMWorkflowAutomation/_git/aa-geo-tools/pullrequests?_a=mine).

## Pull Request Guidelines
Before you submit a pull request, check that it meets these guidelines:

1.
    The pull request should include tests.
2.
    If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the
   feature to the list in README.rst.
3.
    The pull request should work for Python 3.5, 3.6, 3.7, 3.8 and 3.9, and for PyPy..

## Tips
To run a subset of tests::
```
$ pytest tests.test_aa_geo_tools
```

## Deploying
A reminder for the maintainers on how to deploy.
Make sure all your changes are committed (including an entry in HISTORY.md).
Then run::
```
$ pip install -e
$ pytest
$ twin upload dist/*
```
remember to change the version definition on setup.py