Look out for maths terminology that acoustics people won't get; or acoustics terminology that maths people won't get

There should be an interactive page outlining different approximation approaches, Galerkin, interpolation, etc; with examples of piecewise constants, piecewise linears. This can be explained visually in a single page, but a basic understanding is necessary to use packages like bempp. I think @jahargreaves said he had some nice interactive examples on this already...?

This guide should address how to get a working environment on the user's machine, possibly addressing specific OS issues.

_config.yml and contribution guidelines to be updated to new repo location

Probably to reside in /reference/resources.html

It would be sensible to have some guidance to make sure the tutorials are consistent.

I suggest:

• British English spelling
• Follow the Guardian style guide (https://www.theguardian.com/guardian-observer-style-guide-a) as this is detailed and openly available
• Have our own guide of what notation we recommend (Following something like this would make #20 easier (or #20 could effectively be the style guide))

This could form part of the "how to contribute" guide (#17)

Currently, the build system needs every software installed. This will create issues in the future

Probably to reside under /community/community.html or /reference/.

A list of all authors that have contributed to the knowledgebase.

As mentioned by @jahargreaves , things like $\Omega\subset\mathbb{R}^n$ will scare a lot of people away instantly. This needs to be made more accessible.

For contributing on also make sure there is consistency across tutorials, some boiler plate that covers

• What you are expected to know
• next / prep
• rough structure / narrative

Jupiter notebooks that cover

• 1D Wave
• Stiff 1D wave
• 2D Wave
• Stiff Plate
• 3D...
• Optimisations

In the first instance the emphasis should be on clarity over speed. An optimisations section can cover best practice

1. Tell the story, break up into steps, story ends with solution to Helmholtz, time harmonic wave equation (possibly this could go in separate page as it's fairly fundamental).
2. Side stories - jumps in logic, have separate page for derivation, how do operators depend on shape and material. trace conditions taken on trust, with references.
3. What are sub-problems, dense matrix, physical interpretation of this, realising solution from coefficients. Step one, getting your numbers/coefficients, define what they are, then build matrix, then solve system and plug into representation formula
4. Page for approaches for singular integrals, as this is a common stumbling block.

label axes, join ends together of circle sol'n
change n in penultimate cell to m
add full script at the bottom

Something along the lines of

With some animation

Would a tutorial on modal analysis for a cuboid room (maybe the same that's used in the first FEM tutorial) be within the scope of the knowledgebase?

Given the online nature of the site I think there is scope to leverage a little javascript to do some visualisations (possibly even interactive)

I've played around previously with actually doing the drawing:

e.g.

• Modes of 1D Wave
• Thin Plate Model

Mainly looking for suggestions on what level of interactivity could be provided

Could be part of glossary or separate?

For introducing concepts that have multiple different names depending on your field

Include:

• Where to publish code (ie GitHub)
• How to get a DOI for your software (Zenodo/Figshare)
• If you have written a more general library, publish it in JOSS
• License advice

As the book is automatically built and published through github, one should remove the _build directory

Issue for discussing things that need to be added to the glossary

Group the software packages by:

• open source / commercial
• field of application
• computing method (ray-tracing, analytical, FEM, BEM..)

It would be good to use a dynamic table where it's possible to by the fields mentioned above

Brief explanation of Dirichlet, Neumann, Robin boundary conditions and how they relate to real world applications

Jupytext allows you to have automatic sync between multiple file formats, such as .ipynb, .py and .md. It would make it easier for people to download and execute the code (if they do not want to use notebooks, or want to run it in parallel).

We should document the Docker image setup (#56) and make it clear how to add new software to it.

Section could largely be cribbed from Software carpentries

It may also be worthwhile providing a curated list of online notebooks platforms such as

• Google Collab
• Microsoft Azure Notebooks
• Or check with you institute to see if they already have a notebook service (e.g. Notable for University of Edinburgh)

I'm probably missing something here...

Every time the main branch is updated (and the gh-pages branch automatically updated via actions) the custom domain in Settings > Pages changes back to agully1.github.io and I have to manually reset it to knowledgebase.acoustics.ac.uk

Defining who we think the audience is, what we think they already know (and links to how to find it out if not)

From @jahargreaves

A section covering the concepts of an FDTD system.

FDTD specific problems:

• Application of Stencils
• Dispersion
• Stair-casing
• Boundary conditions via ghost nodes
• Viscous losses

Each of these could be discussed via application to ever more complex systems. First in 1D, then 2D, and finally 3D

eg:

• Wave scattering
• eigenvalue problems

It would be nice to offer the option of downloading a .py file as well as installing a .ipynb file. It should be possible to do this by auto-generating the py files rather than adding copies of everything to the repo

Useful for recording impact / demonstrating engagement to potential future funders.

I'd used the Applause button as a temporary solution on the main page, but it feels a bit janky.

Issue for discussing methods to improve SEO

#3 may need sorting first

Currently the Jupyter Book auto builds when new md/notebook content is pushed to main, but this is more complicated with FEniCS leading to errors in the notebook compilation for the first FEniCS tutorial.

Temporary solution: build locally with FEniCS installed