Skip to content

Commit 6546d1e

Browse files
fangqfangq
committed
[spec] BJData spec Draft-3 updates
1 parent 14b23ac commit 6546d1e

File tree

3 files changed

+86
-22
lines changed

3 files changed

+86
-22
lines changed

‎Binary_JData_Specification.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
Binary JData: A portable interchange format for complex binary data
22
============================================================
33

4-
- **Status of this document**: Request for comments
54
- **Maintainer**: Qianqian Fang <q.fang at neu.edu>
65
- **License**: Apache License, Version 2.0
7-
- **Version**: 1 (Draft 3.preview)
8-
- **Last Stable Release**: [Version 1 (Draft 2)](https://github.com/NeuroJSON/bjdata/blob/Draft_2/Binary_JData_Specification.md)
6+
- **Version**: 1 (Draft 3)
7+
- **URL**: https://neurojson.org/bjdata/draft3
8+
- **Status**: Frozen on March 23, 2025. For future updates, please see the Development URL below
9+
- **Development**: https://github.com/NeuroJSON/bjdata
10+
- **Acknowledgement**: This project is supported by US National Institute of Health (NIH)
11+
grant [U24-NS124027 (NeuroJSON)](https://neurojson.org)
912
- **Abstract**:
1013

1114
> The Binary JData (BJData) Specification defines an efficient serialization

‎ChangeLog.txt‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
= Change Log =
2+
3+
Major updates are marked with a "*"
4+
5+
== BJData Spec Draft-3, FangQ <q.fang (a) neu.edu> ==
6+
7+
2025-02-22 [14b23ac] Update README.md
8+
2025-02-22 [1b718a7] Set h background to match float type
9+
2025-02-22 [1c7f954] Update BJData synopsis
10+
2025-02-22 [51830fd] Provide column-major optimized ND array example
11+
2025-02-22 [085d0a4] Update .wordlist.txt
12+
2025-02-22*[a9683d9] Optimized array supports column-major storage
13+
2025-02-22 [7adc621] Update Binary_JData_Specification.md
14+
2024-11-24 [0844096] fix: Byte value example
15+
2024-11-24 [94c5ac7] add "parsers" to wordlist
16+
2024-10-25 [548cc29] Added basic Dependabot configuration
17+
2024-05-10*[f9cd4e3] feat: Binary value type
18+
2024-01-22 [883d1d6] add new word to wordlist
19+
2024-01-22 [e3b9e7b] change urls to https
20+
2024-01-22 [1f4f7fd] add missing config file
21+
2024-01-22 [244422a] add missing config file
22+
2024-01-22 [a8f45ba] add spell checking action
23+
2022-06-09 [d791c73] add 1-page synosis, update all parsers to the latest git versions
24+
25+
== BJData Spec Draft-2, FangQ <q.fang (a) neu.edu> ==
26+
27+
2022-03-02 [98e0b52] update RFC links in README for Draft 2
28+
2022-03-02*[90150eb] Disable `[{SHTFNZ` as optimized type marker due to security risks and diminished benefit
29+
2022-02-22 [996ecb8] Update README.md
30+
2022-02-21 [fc51791] Update Binary_JData_Specification.md
31+
2022-02-21 [ecaf84c] update stable release link to Draft 2
32+
2022-02-21 [83bc0a3] remote outdated module path
33+
2022-02-21 [9231620] add c++ library
34+
2022-02-21 [2429e30] update draft-2 compatible libraries
35+
2022-02-21 [20390d1] Update README.md
36+
2022-02-21 [fb7f438] Polish specification for Draft 2 freeze
37+
2022-02-21 [c78697d] Update README.md
38+
2022-02-21 [f9f872b] Update README.md
39+
2022-02-19 [9edaa9f] fix typo
40+
2022-01-30*[19f4b5c] Breaking: BJData Draft-2 now uses Little-Endian as default int/float byte order
41+
2020-08-10 [d322683] update python modules
42+
2020-07-13 [cb3c5ff] update fully functional python and matlab modules
43+
2020-06-07 [43cb6ea] Update version number
44+
2020-05-16 [8352986] update jsonlab and zmat to the latest
45+
46+
== BJData Spec Draft-1, FangQ <q.fang (a) neu.edu> ==
47+
48+
2020-05-12 [2da127d] update RFC commit link for Draft 1 in README
49+
2020-05-12 [8a6b1a0] update RFC commit link for Draft 1 in README
50+
2020-05-12 [8710a15] change document status to request for comments
51+
2020-05-12 [5d3d88f] Minor language updates
52+
2020-05-12 [8722606] Language proofreading, thanks to Edward Xu (@edwardx324)
53+
2020-05-11 [99fbdb9] Minor language polishing
54+
2020-05-11 [a067ed3] Add introduction
55+
2020-05-08 [a418aaf] add Py-JData module
56+
2020-05-08 [ec2fcf7] add initial python support to BJData draft 1
57+
2020-05-08 [3ae7a1f] sync jsonlab to the latest version
58+
2020-05-06 [a73d201] sync with jsonlab fix
59+
2020-05-06 [214a590] update to the latest jsonlab which supports bjd draft 1
60+
2020-05-04 [ba2726b] Add project logo in README
61+
2020-05-04 [4e25de0] Minor formatting update
62+
2020-05-04 [0cac4cb] Polishing format and language for clarity
63+
2020-05-04 [9f592e8] add BJData compliant parsers
64+
2020-05-04 [92de0c9] H marker should be signed
65+
2020-05-04 [f3d338f] Use IEEE 754 NaN and Infinity binary forms instead of converting to null
66+
2020-05-04 [e98f607] fix formatting of 3D array example
67+
2020-05-04 [95544dc] Add uint16 (u), uint32 (m), uint64 (M), half (h) markers and ND array optimized syntax
68+
2020-05-04 [16c00e2] Update TOC links
69+
2020-05-04 [fdf43b1] Add title, abstract, and acknowledgement
70+
2020-05-03 [7b559a5] renaming document to binary jdata spec
71+
2020-05-03 [582e078] Add README for initial import
72+
2020-05-03 [119d0bd] Initial import of Markup version of UBJSON Spec from https://github.com/Iotic-Labs/py-ubjson

‎README.md‎

Lines changed: 8 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ repository (Commit 5ce1fe7). **The BJData format is no longer backward compatibl
2121

2222
Libraries that support this specification include
2323
- Python: **pybj** (PIP: https://pypi.org/project/bjdata/, Github: https://github.com/NeuroJSON/pybj)
24-
- MATLAB/Octave: **JSONLab** (Debian/Ubuntu/Fedora: `sudo apt-get install octave-jsonlab`, Github: https://github.com/fangq/jsonlab)
24+
- MATLAB/Octave: **JSONLab** (Debian/Ubuntu/Fedora: `sudo apt-get install octave-jsonlab`, Github: https://github.com/NeuroJSON/jsonlab)
2525
- C: **ubj** (Github: https://github.com/NeuroJSON/ubj)
2626
- C++: **JSON for Modern C++** (v3.11.0 or later) (https://github.com/nlohmann/json/)
2727
- JavaScript: **bjd** (npm: https://www.npmjs.com/package/bjd, Github: https://github.com/NeuroJSON/js-bjdata)
@@ -59,27 +59,16 @@ draft of this file specification, including
5959
question, report a bug, provide a feature request, or simply propose
6060
general discussions. Please use URLs or keywords to link your discussion
6161
to a specific line/section/topic in the document.
62-
- [Write short comments on Request for Comments (RFC) commits](https://github.com/NeuroJSON/bjdata/commit/679e92e45aa3ceae9fb5bc74e469ca8cf504be41)
63-
- A milestone version of the specification will be associated with an
64-
RFC (Request for comments) commit (where the entire file is removed
65-
and re-added so that every line appears in such commit). One can
66-
write short comments as well as post replies on this RFC page.
67-
- The latest stable release is **[Version 1 Draft 2](https://github.com/NeuroJSON/bjdata/tree/Draft_2)**. Please use
68-
[this link](https://github.com/NeuroJSON/bjdata/commit/679e92e45aa3ceae9fb5bc74e469ca8cf504be41) to comment.
69-
- To add a comment, you need to first register a github account, and then
70-
browse the above RFC page. When hovering your cursor over each line, a
71-
"plus" icon is displayed, clicking it will allow one to comment on a
72-
specific line (or reply to other's comments).
73-
- The RFC page can get busy if too many comments appear. Please consider
74-
using the [Issues section](https://github.com/NeuroJSON/bjdata/issues) if this happens.
62+
- [Write short comments on Request for Comments (RFC) commits](https://github.com/NeuroJSON/bjdata/releases/tag/Draft-2)
63+
- The latest stable release is **[Version 1 Draft 3](https://github.com/NeuroJSON/bjdata/releases/tag/Draft-2)**
64+
- To add a comment, Please consider using the
65+
[Issues section](https://github.com/NeuroJSON/bjdata/issues)
7566
- One can browse the commit history of the specification document. If
7667
anyone is interested in commenting on a particular updated, you can also
7768
comment on any of the commit page using the same method.
78-
- [Use NeuroJSON mailing list](https://groups.google.com/forum/#!forum/neurojson)
79-
- You may send your comments to the neurojson mailing list (neurojson at googlegroups.com).
80-
Subscribers will discuss by emails, and if a motion is reached, proposals
81-
will be resubmitted as an Issue, and changes to the specification will be
82-
associated with this issue page.
69+
- [Use NeuroJSON Forum](https://github.com/orgs/NeuroJSON/discussions)
70+
- You may send your comments to the neurojson Github forum. You may report
71+
bugs, new features, or submit new datasets.
8372

8473
For anyone who wants to contribute to the writing or revision of this document,
8574
please follow the below steps

0 commit comments

Comments
 (0)