System

This is information about ProjectGeo as a whole.

Python Packages

The core of the project are its geotechnical specialized python packages. These are 2 long-time developed libraries called GeoAssistant and GeoGeometry.

These packages are the starting point of the project, from the real usage of them comes the necessity of documentation. But if we want these packages to be serious, we need to get their docs online, easily accessible for everyone, anytime, anywhere.

The valuable package is GeoAssistant, a highly specialized geotechnical library made for real mining analyses workflows. There no other package like GeoAssistant, at least not public. That is an opportunity, since …

GeoAssistant Landing Page

One of the early problems was that there was no shared ground between the packages, like there was not a page were the user could see that both libraries exist, with links to each of them.

This yield the necessity of a Landing Page, one that has nothing to do with python packages nor Sphinx.

To create this, we use TypeScript + React following Mosh’s curse: “React 18 for Beginners”..

Web Development

The ProjectGeo pages are developed using Typescript + React. The entire development ecosystem is different from what we are used to do. In this case, the IDE of choice is VSCode.

To create a new project we use Vite. In VSCode terminal type:

Authentication

The first obvious issue with putting this information online, is that anyone could see it. Meaning that we definitely need an Authentication system to control who sees what.