auxi


Nameauxi JSON
Version 0.3.6 PyPI version JSON
download
home_pagehttps://github.com/Ex-Mente/auxi.0
SummaryA toolkit to help metallurgical process engineers to rapidly do day-to-day calculations.
upload_time2017-03-27 08:56:44
maintainer
docs_urlNone
authorEx Mente (Pty) Ltd
requires_python
licenseLGPL v3.0
keywords metallurgy
VCS
bugtrack_url https://github.com/Ex-Mente/auxi.0/issues
requirements No requirements were recorded.
Travis-CI
coveralls test coverage
            Master: |masterbuild| |mastercoveralls|

Develop: |developbuild| |developcoveralls| |developcodeclimate|

Welcome to the `auxi` GitHub repository!
========================================

Introduction
------------

`auxi` is a toolkit to help metallurgical process engineers with their day-to-day tasks. Many of the calculations that we do require things like molar masses, conversion of one compound to another using stoichiometry, enthalpy calculations, heat transfer calculations, mass balances, energy balances, etc. It is usually quite time consuming to get started with these calculations in a tool like Excel. `auxi` aims to save you time by making many of these calculations available from within Python.

We hope that `auxi` will help you spend less time focusing on searching for formulas and data, and setting up calculations, and more time on thinking about the problems that you need to solve with these calculations. Enjoy!

Here are some of the other `auxi` resources:

* Documentation: http://auxi.readthedocs.io/en/latest/
* Youtube channel: https://www.youtube.com/channel/UCdklSCJ8S9wFyayLAO7iINQ
* Discussion forum: https://groups.google.com/forum/#!forum/auxi-za
* Waffle issue board: https://waffle.io/Ex-Mente/auxi.0

To install auxi, use the following command: :: 

  pip install auxi



Repository Overview
-------------------

Directory Structure
^^^^^^^^^^^^^^^^^^^

The repository contains the following top-level directories:

* root

  This directory contains the high-level system documentation such as this readme file, and other files that need to be easily accessible to contributors and maintainers. It also contains the `.gitignore` file to specify ignored files and patterns, and `.travis.yml` file to provide configuration details for the Travis.CI continuous integration tool.

* doc

  This directory currently contains the `auxi` user documentation. Detailed system documentation may be added later.

* scripts

  This directory contains scripts used to automate the build and release process.

* auxi

  This directory contains the source files of the Python package.


High-level System Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The `auxi` high-level system documentation consists of the following files:

* ROLES.md

  This document identifies the roles involved in the `auxi` project, and explains the responsibilities and access rights of each role.

* STANDARDS.md

  This document lists and explains the standards that are used in the `auxi` project. If you want to play along nicely when you contribute, you need to know and understand these.

* CONTRIBUTING.md

  This document explains exactly how you can contribute code to `auxi`.

* RELEASING.md

  This document explains how releases are done. Not everyone can do this, but it is important for everyone involved in the project to understand how this works.

* RELEASE-NOTES.md

  This document contains the details of what changed in each `auxi` release.

.. |masterbuild| image:: https://travis-ci.org/Ex-Mente/auxi.0.svg?branch=master
    :target: https://travis-ci.org/Ex-Mente/auxi.0

.. |developbuild| image:: https://travis-ci.org/Ex-Mente/auxi.0.svg?branch=develop
    :target: https://travis-ci.org/Ex-Mente/auxi.0

.. |mastercoveralls| image:: https://coveralls.io/repos/github/Ex-Mente/auxi.0/badge.svg?branch=master
    :target: https://coveralls.io/github/Ex-Mente/auxi.0?branch=master

.. |developcoveralls| image:: https://coveralls.io/repos/github/Ex-Mente/auxi.0/badge.svg?branch=develop
    :target: https://coveralls.io/github/Ex-Mente/auxi.0?branch=develop

.. |developcodeclimate| image:: https://codeclimate.com/github/Ex-Mente/auxi.0/badges/gpa.svg
   :target: https://codeclimate.com/github/Ex-Mente/auxi.0
   :alt: Code Climate

            

Raw data

            {
    "_id": null,
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "cheesecake_code_kwalitee_id": null,
    "keywords": "metallurgy",
    "upload_time": "2017-03-27 08:56:44",
    "author": "Ex Mente (Pty) Ltd",
    "home_page": "https://github.com/Ex-Mente/auxi.0",
    "github_user": "Ex-Mente",
    "download_url": "https://pypi.python.org/packages/a0/f9/b26fe66d0f85851af360b94fb864debfdb598a1549759b135997769cd51f/auxi-0.3.6.tar.gz",
    "platform": "Ubunutu 14.04",
    "version": "0.3.6",
    "cheesecake_documentation_id": null,
    "description": "Master: |masterbuild| |mastercoveralls|\n\nDevelop: |developbuild| |developcoveralls| |developcodeclimate|\n\nWelcome to the `auxi` GitHub repository!\n========================================\n\nIntroduction\n------------\n\n`auxi` is a toolkit to help metallurgical process engineers with their day-to-day tasks. Many of the calculations that we do require things like molar masses, conversion of one compound to another using stoichiometry, enthalpy calculations, heat transfer calculations, mass balances, energy balances, etc. It is usually quite time consuming to get started with these calculations in a tool like Excel. `auxi` aims to save you time by making many of these calculations available from within Python.\n\nWe hope that `auxi` will help you spend less time focusing on searching for formulas and data, and setting up calculations, and more time on thinking about the problems that you need to solve with these calculations. Enjoy!\n\nHere are some of the other `auxi` resources:\n\n* Documentation: http://auxi.readthedocs.io/en/latest/\n* Youtube channel: https://www.youtube.com/channel/UCdklSCJ8S9wFyayLAO7iINQ\n* Discussion forum: https://groups.google.com/forum/#!forum/auxi-za\n* Waffle issue board: https://waffle.io/Ex-Mente/auxi.0\n\nTo install auxi, use the following command: :: \n\n  pip install auxi\n\n\n\nRepository Overview\n-------------------\n\nDirectory Structure\n^^^^^^^^^^^^^^^^^^^\n\nThe repository contains the following top-level directories:\n\n* root\n\n  This directory contains the high-level system documentation such as this readme file, and other files that need to be easily accessible to contributors and maintainers. It also contains the `.gitignore` file to specify ignored files and patterns, and `.travis.yml` file to provide configuration details for the Travis.CI continuous integration tool.\n\n* doc\n\n  This directory currently contains the `auxi` user documentation. Detailed system documentation may be added later.\n\n* scripts\n\n  This directory contains scripts used to automate the build and release process.\n\n* auxi\n\n  This directory contains the source files of the Python package.\n\n\nHigh-level System Documentation\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThe `auxi` high-level system documentation consists of the following files:\n\n* ROLES.md\n\n  This document identifies the roles involved in the `auxi` project, and explains the responsibilities and access rights of each role.\n\n* STANDARDS.md\n\n  This document lists and explains the standards that are used in the `auxi` project. If you want to play along nicely when you contribute, you need to know and understand these.\n\n* CONTRIBUTING.md\n\n  This document explains exactly how you can contribute code to `auxi`.\n\n* RELEASING.md\n\n  This document explains how releases are done. Not everyone can do this, but it is important for everyone involved in the project to understand how this works.\n\n* RELEASE-NOTES.md\n\n  This document contains the details of what changed in each `auxi` release.\n\n.. |masterbuild| image:: https://travis-ci.org/Ex-Mente/auxi.0.svg?branch=master\n    :target: https://travis-ci.org/Ex-Mente/auxi.0\n\n.. |developbuild| image:: https://travis-ci.org/Ex-Mente/auxi.0.svg?branch=develop\n    :target: https://travis-ci.org/Ex-Mente/auxi.0\n\n.. |mastercoveralls| image:: https://coveralls.io/repos/github/Ex-Mente/auxi.0/badge.svg?branch=master\n    :target: https://coveralls.io/github/Ex-Mente/auxi.0?branch=master\n\n.. |developcoveralls| image:: https://coveralls.io/repos/github/Ex-Mente/auxi.0/badge.svg?branch=develop\n    :target: https://coveralls.io/github/Ex-Mente/auxi.0?branch=develop\n\n.. |developcodeclimate| image:: https://codeclimate.com/github/Ex-Mente/auxi.0/badges/gpa.svg\n   :target: https://codeclimate.com/github/Ex-Mente/auxi.0\n   :alt: Code Climate\n",
    "lcname": "auxi",
    "name": "auxi",
    "github": true,
    "bugtrack_url": "https://github.com/Ex-Mente/auxi.0/issues",
    "license": "LGPL v3.0",
    "travis_ci": true,
    "github_project": "auxi.0",
    "summary": "A toolkit to help metallurgical process engineers to rapidly do day-to-day calculations.",
    "split_keywords": [
        "metallurgy"
    ],
    "author_email": "dev@ex-mente.co.za",
    "urls": [
        {
            "has_sig": false,
            "upload_time": "2017-03-27T08:56:44",
            "comment_text": "",
            "python_version": "source",
            "url": "https://pypi.python.org/packages/a0/f9/b26fe66d0f85851af360b94fb864debfdb598a1549759b135997769cd51f/auxi-0.3.6.tar.gz",
            "md5_digest": "4b5532548fce9908d2307ac0f94ae6b1",
            "downloads": 0,
            "filename": "auxi-0.3.6.tar.gz",
            "packagetype": "sdist",
            "path": "a0/f9/b26fe66d0f85851af360b94fb864debfdb598a1549759b135997769cd51f/auxi-0.3.6.tar.gz",
            "size": 515926
        }
    ],
    "cheesecake_installability_id": null,
    "coveralls": true
}
        
Elapsed time: 0.05401s