Skip to content

Commit

Permalink
switch upstream git repo owner to NeuroJSON org
Browse files Browse the repository at this point in the history
  • Loading branch information
fangq committed Aug 22, 2022
1 parent 59d092d commit 290a46c
Show file tree
Hide file tree
Showing 7 changed files with 29 additions and 14 deletions.
2 changes: 1 addition & 1 deletion AUTHORS.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Address: Dept. of Bioengineering
URL: http://fanglab.org
Email: <q.fang at neu.edu>

ZMAT Website : https://github.com/fangq/zmat
ZMAT Website : https://github.com/NeuroJSON/zmat



Expand Down
25 changes: 17 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
.. image:: https://neurojson.org/wiki/upload/neurojson_banner_long.png

##############################################################################
ZMAT: A portable C-library and MATLAB toolbox for zlib/gzip/lzma/lz4/lz4hc data compression
ZMAT: A portable C-library and MATLAB/Octave toolbox for zlib/gzip/lzma/lz4/lz4hc data compression
##############################################################################

* Copyright (C) 2019,2020,2022 Qianqian Fang <q.fang at neu.edu>
* License: GNU General Public License version 3 (GPL v3), see License*.txt
* Version: 0.9.9 (Archie-the-goat - RC1)
* URL: http://github.com/fangq/zmat
* URL: https://github.com/NeuroJSON/zmat
* Acknowledgement: This project is part of the `NeuroJSON project <https://neurojson.org>`_
supported by US National Institute of Health (NIH)
grant `U24-NS124027 <https://reporter.nih.gov/project-details/10308329>`_

.. image:: https://travis-ci.com/fangq/zmat.svg?branch=master
:target: https://travis-ci.com/fangq/zmat
Expand Down Expand Up @@ -71,15 +76,19 @@ variables ``LD_LIBRARY_PATH`` or ``DYLD_LIBRARY_PATH``, respectively).
The pre-compiled mex binaries for MATLAB are stored inside the
subfolder named ``private``. Those precompiled for GNU Octave are
stored in the subfolder named ``octave``, with one operating system
per subfolder.
per subfolder. The ``PKG_ADD`` script should automatically select
the correct mex file when one types ``addpath`` in Octave.
These precompiled mex files are expected to run out-of-box
across a wide-range of MATLAB (tested as old as R2008) and Octave (tested
as old as v3.8).

If you do not want to compile zmat yourself, you can download the
precompiled package by either clicking on the "Download ZIP" button
on the above URL, or use the below git command:

.. code:: shell
git clone https://github.com/fangq/zmat.git
git clone https://github.com/NeuroJSON/zmat.git
================
Installation
Expand Down Expand Up @@ -231,7 +240,7 @@ zmat.m
ss=char(zmat('zmat test',1,'base64'))
orig=char(zmat(ss,0,'base64'))
-- this function is part of the zmat toolbox (http://github.com/fangq/zmat)
-- this function is part of the zmat toolbox (http://github.com/NeuroJSON/zmat)
---------
examples
Expand Down Expand Up @@ -267,7 +276,7 @@ command

.. code:: shell
git clone https://github.com/fangq/zmat.git zmat
git clone https://github.com/NeuroJSON/zmat.git zmat
Next, you need to make sure your system has ``gcc``, ``g++``,
``mex`` and ``mkoctfile`` (if compiling for Octave is needed). If not,
Expand Down Expand Up @@ -372,13 +381,13 @@ following command:

.. code:: shell
git clone https://github.com/fangq/zmat.git zmat
git clone https://github.com/NeuroJSON/zmat.git zmat
or browsing the github site at

.. code:: shell
https://github.com/fangq/zmat
https://github.com/NeuroJSON/zmat
You can make changes to the files as needed. Once you are satisfied with your
Expand Down
2 changes: 1 addition & 1 deletion example/c/testzmat.c
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
** \mainpage ZMat - A portable C-library and MATLAB/Octave toolbox for inline data compression
**
** \author Qianqian Fang <q.fang at neu.edu>
** \copyright Qianqian Fang, 2019-2020
** \copyright Qianqian Fang, 2019,2020,2022
**
** Demo on how to use zmatlib for simple compression and decompression in C
**
Expand Down
5 changes: 4 additions & 1 deletion include/zmatlib.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
** \mainpage ZMat - A portable C-library and MATLAB/Octave toolbox for inline data compression
**
** \author Qianqian Fang <q.fang at neu.edu>
** \copyright Qianqian Fang, 2019-2020
** \copyright Qianqian Fang, 2019,2020,2022
**
** ZMat provides an easy-to-use interface for stream compression and decompression.
**
Expand All @@ -17,6 +17,9 @@
** - lz4 and lz4hc : real-time compression based on LZ4 and LZ4HC algorithms
** - base64 : base64 encoding and decoding
**
** ZMat is part of the NeuroJSON project (https://neurojson.org)
** More information can be found at https://github.com/NeuroJSON/zmat
**
** Depencency: ZLib library: https://www.zlib.net/
** author: (C) 1995-2017 Jean-loup Gailly and Mark Adler
**
Expand Down
5 changes: 4 additions & 1 deletion src/zmat.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
** \mainpage ZMat - A portable C-library and MATLAB/Octave toolbox for inline data compression
**
** \author Qianqian Fang <q.fang at neu.edu>
** \copyright Qianqian Fang, 2019-2020
** \copyright Qianqian Fang, 2019,2020,2022
**
** ZMat provides an easy-to-use interface for stream compression and decompression.
**
Expand All @@ -17,6 +17,9 @@
** - lz4 and lz4hc : real-time compression based on LZ4 and LZ4HC algorithms
** - base64 : base64 encoding and decoding
**
** ZMat is part of the NeuroJSON project (https://neurojson.org)
** More information can be found at https://github.com/NeuroJSON/zmat
**
** Depencency: ZLib library: https://www.zlib.net/
** author: (C) 1995-2017 Jean-loup Gailly and Mark Adler
**
Expand Down
2 changes: 1 addition & 1 deletion test/run_zmat_test.m
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ function run_zmat_test(tests)
% license:
% BSD or GPL version 3, see LICENSE_{BSD,GPLv3}.txt files for details
%
% -- this function is part of ZMat toolbox (https://github.com/fangq/zmat)
% -- this function is part of ZMat toolbox (https://github.com/NeuroJSON/zmat)
%

if (nargin == 0)
Expand Down
2 changes: 1 addition & 1 deletion zmat.m
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
% ss=char(zmat('zmat test',1,'base64'))
% orig=char(zmat(ss,0,'base64'))
%
% -- this function is part of the ZMAT toolbox (http://github.com/fangq/zmat)
% -- this function is part of the ZMAT toolbox (https://github.com/NeuroJSON/zmat)
%

if (exist('zipmat') ~= 3 && exist('zipmat') ~= 2)
Expand Down

0 comments on commit 290a46c

Please sign in to comment.