Documentation

Modules & Packages

v0.0.1

In order to better control all the features of the website/application we decided to divide it into Packages and Modules. Every package have at least one module inside.

If you want to see the list of documentation available, click here.

Summary

1. MarsCalc Package top

This package contains all Modules related to calculation, for example: Bolted Flange Design, Lifting Lug Design and Saddle Support Design.

You can find more about this package in the MarsCalc documentation page .

2. MoonDB Package top

This package contains all Modules related to database, for example: Materials database, Flange database and Gasket database. It's usually used as support module for the calculation modules.

You can find more about this package in the MoonDB documentation page .

3. JupiterQMS Package top

This packaged contains all Modules related to quality, for example: Project Management and Hydrostatic Test.

You can find more about this package in the JupiterQMS documentation page .

4. Status top

There are 5 status:

  1. Development: the module is under development and you can see it's progress in the Development page (to access it, just click in the desired module in the Modules table).
  2. Test: the development phase is over, now it's time to test it. Although it should only be available to our development team, we let Users use the module as well to help us testing it. Just be aware that when the Module is in the Test phase, it must not be used in any real world project. After the Test phase is over, it can go back to Development or go to the next phase: Active.
  3. Active the Module development and Test phase is over and now the Module have the Active status, which means it's ready to be used in real world projects. It may still have some bugs or some features to be implemented, but it'll not affect the design results.
  4. Maintenance: the Modules status will be set to Maintenance when we need to implement some bug fixes or features. It shouldn't take much time as we do all the Test prior the implementation. If the User click in the Module while it have the Maintenance status, a page with the End Date will be show.
  5. Deprecated: when a Module is no longer supported by us, we'll set it as Deprecated. The User can still use it but must keep in mind that we strongly advise to not use it in real world projects.