baselode 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +51 -0
- package/dist/baselode.js +1821 -0
- package/dist/baselode.js.map +1 -0
- package/dist/style.css +1 -0
- package/package.json +60 -0
package/README.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# BASELODE
|
|
2
|
+
|
|
3
|
+
## Free Tooling for the Exploration and Mining Industry
|
|
4
|
+
|
|
5
|
+
`baselode` is a free software project developed by Darkmine Pty Ltd.
|
|
6
|
+
|
|
7
|
+
`baselode` is designed to support the exploration and mining industry, with an ever-growing suite of tools that enable data loading, data modeling, visualization, and common algorithms in one package that can be imported and leveraged without extensive customisation requirements (but is infinitely customizable). This tooling is useful to data scientists, app builders, geologists, mine planners, AI agents, and more.
|
|
8
|
+
|
|
9
|
+
Not all of `baselode` is custom - it pulls from and leverages many other open-source libraries and is designed to further their reach and utility.
|
|
10
|
+
|
|
11
|
+
## Languages
|
|
12
|
+
|
|
13
|
+
This is the javascript version of `baselode`. See also the python module.
|
|
14
|
+
|
|
15
|
+
## Key Features
|
|
16
|
+
|
|
17
|
+
- **Data Loading:** Efficiently import and manage your exploration and mining data.
|
|
18
|
+
- **Data Models:** Utilize predefined models to analyze and interpret your data.
|
|
19
|
+
- **Data Visualization:** Create insightful visualizations to support decision-making.
|
|
20
|
+
- **Common Algorithms:** Access a range of algorithms designed to solve common problems in the industry.
|
|
21
|
+
|
|
22
|
+
## License
|
|
23
|
+
|
|
24
|
+
`baselode` is licensed under the GNU General Public License v3.0 (GPL-3.0) and later. This means you are free to use, modify, and distribute the software, but you must adhere to the terms specified in the GPL-3.0 license. For more details, please refer to the [LICENSE](https://www.notion.so/LICENSE) file.
|
|
25
|
+
|
|
26
|
+
## Obligations
|
|
27
|
+
|
|
28
|
+
By using `baselode`, you agree to the following obligations:
|
|
29
|
+
|
|
30
|
+
- You must preserve the copyright notice and this list of conditions.
|
|
31
|
+
- You must state any significant changes made to the original software.
|
|
32
|
+
- You must distribute your modified source code under the GPL-3.0 license.
|
|
33
|
+
|
|
34
|
+
For any questions or contributions, contact form is at [darkmine.ai](http://darkmine.ai/)
|
|
35
|
+
|
|
36
|
+
## NPM Release
|
|
37
|
+
|
|
38
|
+
This package is configured to take its version from the git tag on the current commit.
|
|
39
|
+
|
|
40
|
+
- Tag format: `vMAJOR.MINOR.PATCH` (example: `v0.1.0`)
|
|
41
|
+
- On `npm pack` or `npm publish`, `prepack` runs `scripts/set-version-from-tag.mjs`
|
|
42
|
+
- The script strips the leading `v` and updates `package.json` version before building
|
|
43
|
+
|
|
44
|
+
Typical publish flow:
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
git tag v0.1.0
|
|
48
|
+
git push origin v0.1.0
|
|
49
|
+
npm run pack:check
|
|
50
|
+
npm run publish:npm
|
|
51
|
+
```
|