Skip to content

Commit 2186db7

Browse files
Initialize core project structure for Embedding Bridge
0 parents  commit 2186db7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+13686
-0
lines changed

.gitignore

Lines changed: 250 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,250 @@
1+
.eb/
2+
.env
3+
bin
4+
### C ###
5+
# Prerequisites
6+
*.d
7+
8+
# Object files
9+
*.o
10+
*.ko
11+
*.obj
12+
*.elf
13+
14+
# Linker output
15+
*.ilk
16+
*.map
17+
*.exp
18+
19+
# Precompiled Headers
20+
*.gch
21+
*.pch
22+
23+
# Libraries
24+
*.lib
25+
*.a
26+
*.la
27+
*.lo
28+
29+
# Shared objects (inc. Windows DLLs)
30+
*.dll
31+
*.so
32+
*.so.*
33+
*.dylib
34+
35+
# Executables
36+
*.exe
37+
*.out
38+
*.app
39+
*.i*86
40+
*.x86_64
41+
*.hex
42+
43+
# Debug files
44+
*.dSYM/
45+
*.su
46+
*.idb
47+
*.pdb
48+
49+
# Kernel Module Compile Results
50+
*.mod*
51+
*.cmd
52+
.tmp_versions/
53+
modules.order
54+
Module.symvers
55+
Mkfile.old
56+
dkms.conf
57+
58+
### Valgrind ###
59+
# Callgrind output files
60+
callgrind.out
61+
callgrind.out.*
62+
63+
# Cachegrind output files
64+
cachegrind.out
65+
cachegrind.out.*
66+
67+
# Massif output files
68+
massif.out
69+
massif.out.*
70+
71+
# BBV output files
72+
bb.out
73+
bb.out.*
74+
75+
valgrind-python.log
76+
77+
78+
# Created by https://www.toptal.com/developers/gitignore/api/python
79+
# Edit at https://www.toptal.com/developers/gitignore?templates=python
80+
81+
### Python ###
82+
# Byte-compiled / optimized / DLL files
83+
__pycache__/
84+
*.py[cod]
85+
*$py.class
86+
87+
# Distribution / packaging
88+
.Python
89+
build/
90+
develop-eggs/
91+
dist/
92+
downloads/
93+
eggs/
94+
.eggs/
95+
lib/
96+
lib64/
97+
parts/
98+
sdist/
99+
var/
100+
wheels/
101+
share/python-wheels/
102+
*.egg-info/
103+
.installed.cfg
104+
*.egg
105+
MANIFEST
106+
107+
# PyInstaller
108+
# Usually these files are written by a python script from a template
109+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
110+
*.manifest
111+
*.spec
112+
113+
# Installer logs
114+
pip-log.txt
115+
pip-delete-this-directory.txt
116+
117+
# Unit test / coverage reports
118+
htmlcov/
119+
.tox/
120+
.nox/
121+
.coverage
122+
.coverage.*
123+
.cache
124+
nosetests.xml
125+
coverage.xml
126+
*.cover
127+
*.py,cover
128+
.hypothesis/
129+
.pytest_cache/
130+
cover/
131+
132+
# Translations
133+
*.mo
134+
*.pot
135+
136+
# Django stuff:
137+
*.log
138+
local_settings.py
139+
db.sqlite3
140+
db.sqlite3-journal
141+
142+
# Flask stuff:
143+
instance/
144+
.webassets-cache
145+
146+
# Scrapy stuff:
147+
.scrapy
148+
149+
# Sphinx documentation
150+
docs/_build/
151+
152+
# PyBuilder
153+
.pybuilder/
154+
target/
155+
156+
# Jupyter Notebook
157+
.ipynb_checkpoints
158+
159+
# IPython
160+
profile_default/
161+
ipython_config.py
162+
163+
# pyenv
164+
# For a library or package, you might want to ignore these files since the code is
165+
# intended to run in multiple environments; otherwise, check them in:
166+
# .python-version
167+
168+
# pipenv
169+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
170+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
171+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
172+
# install all needed dependencies.
173+
#Pipfile.lock
174+
175+
# poetry
176+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
177+
# This is especially recommended for binary packages to ensure reproducibility, and is more
178+
# commonly ignored for libraries.
179+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
180+
#poetry.lock
181+
182+
# pdm
183+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
184+
#pdm.lock
185+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
186+
# in version control.
187+
# https://pdm.fming.dev/#use-with-ide
188+
.pdm.toml
189+
190+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
191+
__pypackages__/
192+
193+
# Celery stuff
194+
celerybeat-schedule
195+
celerybeat.pid
196+
197+
# SageMath parsed files
198+
*.sage.py
199+
200+
# Environments
201+
.env
202+
.venv
203+
env/
204+
venv/
205+
ENV/
206+
env.bak/
207+
venv.bak/
208+
209+
# Spyder project settings
210+
.spyderproject
211+
.spyproject
212+
213+
# Rope project settings
214+
.ropeproject
215+
216+
# mkdocs documentation
217+
/site
218+
219+
# mypy
220+
.mypy_cache/
221+
.dmypy.json
222+
dmypy.json
223+
224+
# Pyre type checker
225+
.pyre/
226+
227+
# pytype static type analyzer
228+
.pytype/
229+
230+
# Cython debug symbols
231+
cython_debug/
232+
233+
# PyCharm
234+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
235+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
236+
# and can be added to the global gitignore or merged into this file. For a more nuclear
237+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
238+
#.idea/
239+
240+
### Python Patch ###
241+
# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
242+
poetry.toml
243+
244+
# ruff
245+
.ruff_cache/
246+
247+
# LSP config files
248+
pyrightconfig.json
249+
250+
# End of https://www.toptal.com/developers/gitignore/api/python

.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "npy_array"]
2+
path = npy_array
3+
url = https://github.com/oysteijo/npy_array

CONTRIBUTING.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Contributing to Embedding Bridge
2+
3+
We love your input! We want to make contributing to Embedding Bridge as easy and transparent as possible.
4+
5+
## Development Process
6+
7+
1. Fork the repo and create your branch from `main`.
8+
2. Make your changes.
9+
3. If you've added code, add tests.
10+
4. Ensure the test suite passes.
11+
5. Make sure your code follows the style guidelines.
12+
6. Issue a pull request.
13+
14+
## Code Style
15+
16+
- Use 8-character indentation
17+
- Maximum line length of 80 characters
18+
- Clear and descriptive variable names
19+
- Functions should do one thing and do it well
20+
- Comprehensive error handling
21+
- Comments should explain WHY, not WHAT
22+
23+
## Pull Request Process
24+
25+
1. Update the README.md with details of changes if needed.
26+
2. Update the documentation if you're introducing new features.
27+
3. The PR will be merged once you have the sign-off of at least one maintainer.
28+
29+
## License
30+
31+
By contributing, you agree that your contributions will be licensed under the GNU General Public License v2.0.
32+
33+
## Questions?
34+
35+
Feel free to open an issue for any questions or concerns.

0 commit comments

Comments
 (0)