Skip to main content

Changing library status

You will have noticed from the front page that libraries on ArupCompute are categorised into four groups.

Library categories​

Public​

Libraries ready for use by all of Arup.

Background​

These libraries are the engine behind other apps and services - as such they are not optimised for use via the web, but feel free to take a look around and see what people are using ArupCompute for!

Labs​

Trials, experiments, the new and unrefined. Don't expect things in here to work, and do not rely on them for production. Perhaps you will stumble across an interesting idea or colleague by browsing this collection.

End Of Life​

These libraries are superseded, but are kept running to power existing scripts and services.

Moving from one category to another​

By default any new library you create will go into 'Labs'. This allows interested parties to see what is being worked on, without overwhelming casual users of ArupCompute with a long list of libraries that may not be relevant to them.

When you think your library is ready to go from Labs to another category reach out to [email protected] who will then check the library for quality, and then move it to help you reach a wider audience.

Quality checklist​

The below list is how sufficient quality to be made 'Public' will be assessed:

  • Library purpose does not overlap with an existing Public library
WHY

It's in the best interest of Arup to focus our efforts on making high quality libraries that each serve a specific need, rather than having many similar sounding libraries of varying quality.

For example if you are interested in writing engineering calculations you should contribute to DesignCheck rather than creating a competing service.

  • Library description (which appears on the library page) is clear as to the purpose of the library
  • Library functions are clearly organised
  • Functions are clearly named
  • All functions have descriptions
  • All function inputs have clear descriptions
  • Functions state assumptions, and provide links to supporting documentation where necessary