/$$$$$$                                             
 /$$__  $$                                            
| $$  \__/      /$$$$$$$  /$$$$$$   /$$$$$$   /$$$$$$ 
| $$$$ /$$$$$$ /$$_____/ /$$__  $$ /$$__  $$ /$$__  $$
| $$_/|______/| $$      | $$  \ $$| $$  \__/| $$$$$$$$
| $$          | $$      | $$  | $$| $$      | $$_____/
| $$          |  $$$$$$$|  $$$$$$/| $$      |  $$$$$$$
|__/           \_______/ \______/ |__/       \_______/                                                  

About

f-core is the core lib of f-utils. It provides the primitive accessible types, type operations and spectra.

Structure

f_core/
  |-- __init__.py ........ import main.py 
  |-- main.py ............ import the modules and define classes s, t, o and g
  `-- mods/
       |-- type/ ......... define the primitive types
       |-- op/ ........... define the primitive type operations
       |-- spec/ ......... define the primitive spectra
       `-- glob/ ......... define the primitive globals

Dependencies

1. python >= 3.9
2. f-utils/f

Install

Through the main and dev branches of this repo:

• With pip:

# main branch
/path/to/venv/bin/pip install git+https://github.com/f-utils/f-core
# dev branch
/path/to/venv/bin/pip install git+https://github.com/f-utils/f-core/tree/dev

For other installation options, see futils.org/install.

Usage

We recommend to include f-core directly:

from f_core import *

This will provide the following classes:

class      alias    scope
-------------------------------------------
Types      t        primitive types
Ops        o        primite type operations
Globals    g        primite globals
Specs      s        primitive spectra

For more details, see futils.org/libs/f-core.

Contributing

• Open issues in f-utils/.issues.
• Join our Discord server.
• See CONTRIBUTING.

License

This software is licensed under BSD Clause-3.