Addition of 1.5 inch pipe to pipe database

The 1.5" pipe (in nominal diameter) is now available for use in core.pipes.

Documentation for Unit Registry

The AguaClara package documentation now lists common units and constants available in the package's unit registry! This list is found in the documentation page for core.units.

Several constants in core.constants have also been marked as deprecated due to irrelevance or redundancy with Pint package units and constants.

Improved documentation and inclusion of set_sig_figs() in imports

This release includes three updates:

• aguaclara.core.pipes is now included in the AguaClara package documentation
• The documentation site homepage has instructions on installing, contributing to, and using the package
• aguaclara.core.units has been added to package level imports, so set_sig_figs() can be accessed like so:

  import aguaclara as ac
  ac.set_sig_figs(3)

Hidden documentation fix

All functions in physchem now have visible documentation on the aguaclara documentation website.

ProCoDA Parser Enhancements

In the aguaclara.research.procoda_parser module, the default file extension for ProCoDA data files is now ".tsv" instead of ".xls". There are two functions in the module, plot_columns() and iplot_columns(), for quickly plotting columns of data in a ProCoDA data file. Additionally, columns_of_data() and columnn_of_time() now silently ignore notes instead of raising an error.

Python/Onshape Integration of the Flocculator

This release provides the ability to design an Onshape flocculator using the values calculated by our Python design code.

To design a flocculator, run the following in a Colab notebook:

!pip install aguaclara

import aguaclara as ac
from aguaclara.core.units import u

floc = ac.Flocculator()
floc.onshape_url_configured

The URL to the configured Onshape model with then appear, which you can navigate to and view. This early stage implementation does not provide the ability to resize the entrance tank in tandem with the flocculator, although, that functionality (as well as functionality for all other plant components) will come soon.

Pipeline Design Features

This release provides functionality for designing pipelines of linear, continuous flow.

• Each pipeline (component) that is created is ensured to have a valid nominal size that is constructable.
• Each pipeline has the ability to find a head loss from a target flow rate, and vice-versa.

There are three concrete classes (Pipe, Tee, Elbow) which can be instantiated, and one abstract class that can be used to make custom components (PipelineComponent). To create a pipeline, chain together multiple components like you would with a linked list:

import aguaclara as ac
from aguaclara.core.units import u

pipeline = ac.Pipe(next = ac.Elbow(next = ac.Pipe(next = ac.Tee())))
pipeline.headloss_pipeline()
pipeline.flow_pipeline(target_headloss = 20 * u.cm)

Important notes:

• Tee currently only has functionality to simulate a tee fitting with one (and only one) socket being covered by a stopper. However, there is the option to choose which socket is covered by the stopper.
• The old aguaclara.core.pipes module still works the same, but we encourage you to use the new classes as shown above.

New import structure, flocculator design code fixes

This release implements the new import structure touched upon in #214. Now, the standard NumPy-like import structure is available in addition to the old module-based import structure:

import aguaclara as ac
from aguaclara.core.units import u
ac.viscosity_kinematic(30 * u.deg)

This release also changes the behavior of the Flocculator design code:

• Fixed calculation of channel number and width
• Can now specify the parity (odd, even, any) of the channel number

Add deprecation warning for round_sf

Deprecate round_sf for round_sig_figs (#220)

* Add back deprecation warning

* Add documentation

* Increment version to 0.1.3

Sedimentor design code, Component class fixes

• Added new physchem functions for designing manifolds and channels
• Added design code for the Sedimentor
• Refined Component class for fine-tuning plant designs
• Refactored and improved utility functions