Skip to main content

Python Templates

This template approach simplifies the process of starting a new ArupCompute library by providing an automated approach to:

  • Creating a code repository for your new library on the Arup GitHub
    • Stores your code in the cloud ensuring it will never get lost
    • Allows other staff members to collaborate with you
  • Setting up a new python library ready for deployment to ArupCompute
    • Includes good practice such as automated testing
    • Creates a basic first function with all the relevant meta-data required for ArupCompute
  • Automated deployment pipelines
    • Creates a new library on ArupCompute without needing to use the ArupCompute user interface
    • Allows you to automatically update your library on ArupCompute when you are ready to release a new version

Prerequisities​

To successfully write a new ArupCompute library using the template approach you will need:

  • To be able to access the Arup GitHub
  • To be able to move code between your local environment and GitHub
  • Have a development environment setup to write your code in

Need some guidance on how to do any of these? Check out our new developers guide

Writing your functions​

This guide just covers setting up your library. For more detailed guidance on how to to write your functions to take advantage of all of the features ArupCompute provides refer to the library development guidance.

Existing libraries​

Already have a repository setup for your ArupCompute code, but want to take advantage of these template deployment pipelines? Skip ahead to add to your existing library.