All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
0.5.0b0 - 2021-01-18
- Nek parameter
filter_modes
for HPFRT andwrite_to_field_file
- Function
load_simul
to load simulations from a directory.
- Depend on
fluidsim-core
instead offluidsim
- Parameters, entry points and magic implementation from fluidsim-core (#15)
- Output class now conforms to
fluidsim-core
API. Fileparams.xml
renamed toparams_simul.xml
(#16)
0.4.1b1 - 2020-10-26
- Rewrite README and docs for better onboarding
0.4.1b0 - 2020-10-26
- Support for Python 3.6.x
- Support for FluidSim 0.3.3
- Descriptive error messages when class Output cannot resolve resources
0.4.0b1 - 2020-07-15
- Parameters for specifying mesh origin and ratio
- Coverage tests
- Support for Nek5000 v19
- Cluster's default project
- Activate
$PATH
logic, added tests - No error raised by
prepare_for_restart
after unlock - Bug fixes while archiving: choosing paths of new tarball
0.3.1a0 - 2020-05-10
- More assets: templates, default snakemake config
- Source root path expands ~ and environment variables
0.3.0a0 - 2020-05-09
- Sub-package
assets
and moduleoutput.base
- Helper functions
source_root
andget_asset
- Separate framework from the code and rename it to
snek5000
- Documentation and readme to reflect the package
- ABL source code
0.2.2 - 2020-05-08
- Pre-commit: black, flake8, isort fixing and linting support
- Jupyterlab and ipykernel configuration snakemake rules
- Job management script - organize.py
- New module: const
- Parameters for Maronga case
- Compilation is now parallel
- Two-step archival, tar and compress
- Snakemake: gslib dependency before compiling
- Snakemake: Tee output to log file
- Requirements files produced using pip-tools
0.2.1 - 2020-04-14
- Tar shell functions in activate script
- Module
snek5000.clusters
for job submission
- Conda environment packages
- Reduced pressure residual tolerance for divergence check
- Bugfixes for simulation parameter loading, restart
- Snakefile dependencies for running a simulation
0.2.0 - 2020-03-22
- KTH toolbox
- Coriolis force
- Job submission in cluster
- More user_params
- Archives use zstd compression
- user_params is a dictionary
- Initial condition bug in setting velocities in
useric
- Cs - Cs**2 in
eddy_visc
- Assert exit code of snakemake results in tests
- Subroutine
set_forcing
uses ux.. instead of vx
0.1.1 - 2020-01-27
- Templates in
abl.templates
subpackage - Expand parameters and write methods in class
Operators
- Improved tests and documentation
- Solver
abl
respects parameters and writes box and SIZE files.
- Snakecase for
nek
parameters
0.1.0 - 2020-01-23
- Uses
fluidsim
framework for creating a scripting layer - Package
abl
with a single module and anabl.Output
class - New sub-packages and modules under
snek5000
:solvers, output, info, log, make, magic, operators
- Testing with
pytest
, and CI on GitHub actions - Detailed documentation
- Versioning with
setuptools_scm
- Extra requirements
[test]
renamed to[tests]
- Rename case files
3D_ABL
->abl
and directoryabl_nek5000
->abl
- Overall reorganization of modules and Snakemake + configuration files.
0.0.1 - 2020-01-17
- Scripting for managing run parameters
snek5000.params
- Python packaging
- Sphinx + Doxygen + Breathe documentation