Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Molass Developer’s Handbook

Introduction

The Molass Community welcomes anyone interested in SEC-SAXS data analysis. Feel free to contribute by opening issues using the github icon button at the upper right corner of any page.

This book is intended to help contributors to the project.

Skilled programmers are advised to skip the first chapter on environments, for those are simple orientations attended to beginners who might get involved.

Acknowledging GitHub Copilot

As we wrote this book, we realized the idea of cleverly utilizing GitHub Copilot[1], the AI programming assistant. Namely, we don’t need to describe in detail what GitHub Copilot can do. Instead, by assuming its assistance, it may be more effective or sufficient to focus on what to ask and leave the descriptive work[2] to GitHub Copilot, which can handle certain (potentially tedious) tasks more efficiently.[3]

This section serves as a general assertion and will not be repeated verbosely throughout the book, except in cases where its significance needs to be emphasized.

Footnotes
  1. Or any other assistant of your choice. “Cleverly” here is meant that we should also be aware of its weaknesses such as verbosity, lack of focus, know-it-all attitude, risk-avoiding all-things suggestions, etc.

  2. That is, we do not need to include such details in this book. Instead, it will suffice to state only the key points, without omitting a minimal description to avoid the loss of clarity. With some hints on what to ask or how to ask, which we will not omit, further details, which we will omit, can be left to the assistant, who can help in your need.

  3. See Coding Style and AI Assisted Development for such style of description.