New package: Numav v0.1.0

[JuliaRegistrator]

• Registering package: Numav
• Repository: https://github.com/mmfiuza/numav
• Created by: @mmfiuza
• Version: v0.1.0
• Commit: 40f692a844d8124bab41cbfb40fa6714296226f6
• Reviewed by: @mmfiuza
• Reference: mmfiuza/numav@40f692a#commitcomment-187796072
• Description: Secret project!

[github-actions]

Hello, I am an automated registration bot. I help manage the registration process by checking your registration against a set of AutoMerge guidelines. If all these guidelines are met, this pull request will be merged automatically, completing your registration. It is strongly recommended to follow the guidelines, since otherwise the pull request needs to be manually reviewed and merged by a human.

1. New package registration

Please make sure that you have read the package naming guidelines.

2. AutoMerge Guidelines are all met! ✅

Your new package registration met all of the guidelines for auto-merging and is scheduled to be merged when the mandatory waiting period (3 days) has elapsed.

3. To pause or stop registration

If you want to prevent this pull request from being auto-merged, simply leave a comment. If you want to post a comment without blocking auto-merging, you must include the text [noblock] in your comment.

Tip: You can edit blocking comments to add [noblock] in order to unblock auto-merging.

[mmfiuza]

Description of the package

Numav (NUMerical Acoustics and Vibrations) is a C++ library I'm currently developing to perform simulations related to acoustics and vibrations. The package Numav.jl is the C++ library with bindings for Julia, using CxxWrap.jl. For fast solving, it relies on Intel oneMKL.

Why I need this package to be registered

I know that this package is still in an initial stage of development. It doesn't even have proper documentation yet. Despite that, I want some colleges at my university to start using this library as soon as possible. This will really help me to get feedback. Since they are new to Julia, I want the installation to be as simple as typing ] add Numav. This package is not meant for for personal or internal usage. I'm improving it to make it easy to use by anyone, with good documentation soon.

Here is a quick example of how the API looks like

using Numav

# create the simulation object with some numerical method
s = Simulation{
    Phenomenon.acoustic,
    NumericalMethod.fem,
    Domain.frequency,
    Dimension.d3,
    ElementOrder.o1
}()

# determine simulation frequency
freq_min= 40
freq_max = 100
set_frequency_range(s, freq_min, freq_max)

# load the mesh
load_mesh(s, "some_mesh_file.bdf")

# add a volume material
rho(f) = 1.20
c(f) = 343
add_volume_material(s, physical_group=1, density=rho, sound_speed=c)

# add volume velocity source
Q(f) = 10/f
add_sound_source(s, coordinates=[1.0, 1.5, 2.0], volume_velocity=Q)

# add particle velocity source
U(f) = 15/f
add_sound_source(s, physical_group=2, particle_velocity=2)

# add pressure sources
P(f) = 2f
add_sound_source(s, coordinates=[2.0, 2.5, 1.0], pressure=P)
add_sound_source(s, physical_group=3, pressure=P)

# add specific surface acoustic impedance
Z(f) = 1f + 2im
add_surface_material(s, physical_group=4, impedance=Z)

set_result_export_path(s, "result.h5")

# run the simulation
simulate(s)

[noblock]

[goerz]

The name similarity is not an issue.

However,

It doesn't even have proper documentation yet

should be fixed before registering the package.

I want the installation to be as simple as typing ] add Numav

] add https://github.com/mmfiuza/numav:julia-bindings/Numav.jl

seems hardly less simple just to allow colleagues to use a package. I would also mention the [Sources] section in a Project.toml.

For a package to be registered, any potential user should be able figure out what the package is about and how to get started with using it. That is really difficult when there is no documentation. The subfolder containing the Julia bindings should have an independent README explaining the relation to the overall project and giving some usage examples.

[kellertuer]

[noblock]

I think the name could be ok; I personally would favour a name that transports a bit better what the package does (A for accustics, v for vibrations?), but there is no strict rules against names like these. Maybe also NumAV.jl would be a better capitalisation then?
To me, espcially vibrations leave to many nice word puns - for example NumBrumm (though maybe also just my German brain)!

I would also recommend to call the repository maybe PackageName.jl ? (with right capitalisation and jl in the end)

But that is of course up to you.

Besides that I agree with Michael, that the docs and testing should be improved. Currently the Readme mainly states how things can be installed but not how they can be used.

[lgoettgens]

I would also recommend to call the repository maybe PackageName.jl ? (with right capitalisation and jl in the end)

Since the repository is mainly about the c++ library, I think it makes more sense to keep the repository name. After all, the subdirectory is called "Numav.jl".

[noblock]

[kellertuer]

[noblock]

Thanks for the note, I missed that, since it is in a subfolder – sure, then the repository name is good as it is.