Welcome to auxi’ user manual!¶
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, 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 on thinking about the problems that you need to solve with these calculations. Enjoy!
For video tutorials on using auxi visit auxi youtube .
Getting Started¶
Structure¶
auxi is a Python package, and it is currently divided into two main sub-packages, namely tools and modelling. The tools package provides help with simple tasks like calculating molar masses, enthalpies of heat capacities. The modelling package helps you to do more sophisticated calculations, and to build process models.
Tools¶
This package currently only contains a single set of tools, namely for chemistry calculations.
Modelling Frameworks¶
This package contains modules, functions and classes for developing different types of computational models.
auxi Reference¶
- auxi package
- Subpackages
- auxi.core package
- auxi.modelling package
- Subpackages
- auxi.modelling.business package
- auxi.modelling.financial package
- auxi.modelling.process package
- Subpackages
- auxi.modelling.process.materials package
- Submodules
- auxi.modelling.process.materials.chem module
- auxi.modelling.process.materials.chem_test module
- auxi.modelling.process.materials.core module
- auxi.modelling.process.materials.core_test module
- auxi.modelling.process.materials.psd module
- auxi.modelling.process.materials.psd_test module
- auxi.modelling.process.materials.slurry module
- auxi.modelling.process.materials.slurry_test module
- auxi.modelling.process.materials.thermo module
- auxi.modelling.process.materials.thermo_test module
- Module contents
- Submodules
- auxi.modelling.process.materials package
- Module contents
- Subpackages
- Module contents
- Subpackages
- auxi.tools package
- Subpackages
- auxi.tools.chemistry package
- auxi.tools.materialphysicalproperties package
- Submodules
- auxi.tools.materialphysicalproperties.core module
- auxi.tools.materialphysicalproperties.core_test module
- auxi.tools.materialphysicalproperties.gases module
- auxi.tools.materialphysicalproperties.idealgas module
- auxi.tools.materialphysicalproperties.idealgas_test module
- auxi.tools.materialphysicalproperties.liquids module
- auxi.tools.materialphysicalproperties.polynomial module
- auxi.tools.materialphysicalproperties.polynomial_test module
- auxi.tools.materialphysicalproperties.slags module
- Module contents
- Submodules
- auxi.tools.transportphenomena package
- Submodules
- Module contents
- Subpackages
- Submodules
- Module contents
- Subpackages