Skip to main content

A package to convert your Jupyter Notebook

Project description

onedani

This library facilitates educators to help students understand 1D wall conduction problems through a simple 1D visualization animation.

License

:package: Installation

pip install onedani

:rocket: How to use

You can build a simple animation with the following code:

from onedani import animation.onedproblem

# Setup the wall elments, by material, and thickness of each material
wall = onedproblem(
    ['plywood','rockwool','osb','airgap','plaster'],
    [0.01,0.1,0.012,0.02,0.02]
)
# You can set the time
wall.setup_grid(50,time=30,fps=60) # 30 seconds of 24fps
# Add probed to measure the temperature
wall.add_probe(x=sum([0.01,0.1,0.012]),type='Temp')
# Add probe to measure the heat flux
wall.add_probe(x=sum([0.01,0.03]),type='Heat')
# Run the 1D problem
wall.run_problem()
# Build the animation
wall.build_animation(scale="C",filename='animation_10.mp4')

:memo: Features

  • Build animations based on simple materials.
  • Specify animation length, we will ensure it will always reach steady state at the end of the time.
  • Add temperature and heat flux probes to show the results on the animation.

:eyes: Watch out

  • This package is build on a (very) simple numerical solver and schema, this means there will be some numerical error.
  • This is especially true for heat probes:
    • it's reduced by increasing the number of x-nodes
    • or making sure the heat probe is somewhere in the center of a material.

:new: Versions

Version 0.1

  • Initial public release, the students enjoyed seeing the temperature evolve through the wall.

:pray: Acknowledgement

I would like to the thank Dr. Ralph Evins from the Energy in Cities group for the opportunity to teach in his CIVE 295 - Building Science Fundamentals class. The problem here and the questions from the students resulted in me repurposing some code I made in my PhD to make this animation.

Project details


Release history Release notifications | RSS feed

This version

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

onedani-0.1.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

onedani-0.1-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file onedani-0.1.tar.gz.

File metadata

  • Download URL: onedani-0.1.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for onedani-0.1.tar.gz
Algorithm Hash digest
SHA256 51b3c96f47ea414d9db6a29ef592824bf5fefceb84dcfae733cb04fadd3fb2c3
MD5 5d6c96bd4d7a83f3e2f22bedd4d67390
BLAKE2b-256 3f0043fe8ce3068aa34091ba1c3ecea65861634ca51f64914dde56d07d96ab35

See more details on using hashes here.

File details

Details for the file onedani-0.1-py3-none-any.whl.

File metadata

  • Download URL: onedani-0.1-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for onedani-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f617459ebcb47e6a625a079e7db6700d51f7ebc8044295220cd9bc288badc261
MD5 62e24df6617400b107dacf63006e4dd0
BLAKE2b-256 35b491af55293d280964b0d65624c373bb3ec78c560becbddfde818ae752f0ae

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page